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;
020
021import javax.annotation.concurrent.ThreadSafe;
022import java.util.Map;
023import java.util.Optional;
024
025/**
026 * Immutable validated arguments for one MCP prompt invocation.
027 *
028 * <p>The argument map contains only arguments declared by the prompt.
029 * Required arguments are guaranteed to be present before the handler runs.
030 * Omission and an explicitly supplied empty string remain distinct.
031 * Structural validation does not establish a business allowlist, resistance
032 * to prompt injection, authorization to access referenced data, or safe model
033 * output. Those semantic policies remain application responsibilities and
034 * should be evaluated before any referenced resource is accessed.
035 *
036 * @author <a href="https://www.revetkn.com">Mark Allen</a>
037 */
038@ThreadSafe
039public interface McpPromptGetContext {
040        /**
041         * Returns supplied arguments in their wire order.
042         *
043         * @return immutable argument-name to exact string-value map
044         */
045        @NonNull
046        Map<@NonNull String, @NonNull String> getArguments();
047
048        /**
049         * Finds a supplied argument by its declared name.
050         *
051         * @param name declared prompt argument name
052         * @return exact supplied value, or empty when omitted
053         */
054        @NonNull
055        Optional<@NonNull String> findArgument(@NonNull String name);
056}