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 org.jspecify.annotations.Nullable;
020
021import java.lang.annotation.ElementType;
022import java.lang.annotation.Retention;
023import java.lang.annotation.RetentionPolicy;
024import java.lang.annotation.Target;
025
026/**
027 * Applies to methods that expose an MCP prompt.
028 *
029 * @author <a href="https://www.revetkn.com">Mark Allen</a>
030 */
031@Target(ElementType.METHOD)
032@Retention(RetentionPolicy.RUNTIME)
033public @interface McpPrompt {
034        /**
035         * Declares the MCP prompt name.
036         *
037         * @return the prompt name exposed to MCP clients
038         */
039    String name();
040
041        /**
042         * Declares the human-readable prompt description.
043         *
044         * @return the prompt description
045         */
046    String description();
047
048        /**
049         * Declares optional prompt title metadata for clients that display a separate title.
050         *
051         * @return the prompt title, or an empty string if unspecified
052         */
053    @Nullable
054    String title() default "";
055}