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.annotation;
018
019import com.soklet.McpInputRequirement;
020import com.soklet.McpInputRequestType;
021import org.jspecify.annotations.NonNull;
022
023import java.lang.annotation.ElementType;
024import java.lang.annotation.Retention;
025import java.lang.annotation.RetentionPolicy;
026import java.lang.annotation.Target;
027
028/**
029 * Declares one client request that an annotated MCP operation may emit.
030 *
031 * <p>This annotation is used only as a nested value within an MCP operation
032 * annotation.
033 *
034 * @author <a href="https://www.revetkn.com">Mark Allen</a>
035 */
036@Target({})
037@Retention(RetentionPolicy.RUNTIME)
038public @interface McpMayRequestInput {
039        /**
040         * The core client-input request type.
041         *
042         * <p>The selected type determines the JSON-RPC method and base client
043         * capability.
044         *
045         * @return client-input request type
046         */
047        @NonNull
048        McpInputRequestType type();
049
050        /**
051         * When the declared capabilities are required.
052         *
053         * @return input requirement
054         */
055        @NonNull
056        McpInputRequirement requirement();
057}