001/*
002 * Copyright 2022-2026 Revetware LLC.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.soklet;
018
019import org.jspecify.annotations.NonNull;
020import org.jspecify.annotations.Nullable;
021
022import javax.annotation.concurrent.Immutable;
023import java.util.List;
024
025import static java.util.List.of;
026import static java.util.Objects.requireNonNull;
027
028/**
029 * Immutable MCP prompt result.
030 *
031 * @author <a href="https://www.revetkn.com">Mark Allen</a>
032 */
033@Immutable
034public record McpPromptResult(
035                @Nullable String description,
036                @NonNull List<@NonNull McpPromptMessage> messages
037) {
038        public McpPromptResult {
039                requireNonNull(messages);
040                messages = List.copyOf(messages);
041        }
042
043        /**
044         * Creates a prompt result containing only messages.
045         *
046         * @param messages the prompt messages
047         * @return a prompt result without a description
048         */
049        @NonNull
050        public static McpPromptResult fromMessages(@NonNull McpPromptMessage... messages) {
051                requireNonNull(messages);
052                return new McpPromptResult(null, of(messages));
053        }
054
055        /**
056         * Creates a prompt result containing a description and messages.
057         *
058         * @param description the prompt result description
059         * @param messages the prompt messages
060         * @return a prompt result with a description
061         */
062        @NonNull
063        public static McpPromptResult fromDescriptionAndMessages(@NonNull String description,
064                                                                                                                                                                                                                                         @NonNull McpPromptMessage... messages) {
065                requireNonNull(description);
066                requireNonNull(messages);
067                return new McpPromptResult(description, of(messages));
068        }
069}