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 classes that expose an MCP endpoint.
028 *
029 * @author <a href="https://www.revetkn.com">Mark Allen</a>
030 */
031@Target(ElementType.TYPE)
032@Retention(RetentionPolicy.RUNTIME)
033public @interface McpServerEndpoint {
034        /**
035         * Declares the HTTP path for the MCP transport endpoint.
036         *
037         * @return the MCP endpoint path
038         */
039    String path();
040
041        /**
042         * Declares the MCP server name.
043         *
044         * @return the server name exposed during initialization
045         */
046    String name();
047
048        /**
049         * Declares the MCP server version.
050         *
051         * @return the server version exposed during initialization
052         */
053    String version();
054
055        /**
056         * Declares optional server instructions metadata.
057         *
058         * @return the server instructions, or an empty string if unspecified
059         */
060    @Nullable
061    String instructions() default "";
062
063        /**
064         * Declares optional server title metadata.
065         *
066         * @return the server title, or an empty string if unspecified
067         */
068    @Nullable
069    String title() default "";
070
071        /**
072         * Declares optional server description metadata.
073         *
074         * @return the server description, or an empty string if unspecified
075         */
076    @Nullable
077    String description() default "";
078
079        /**
080         * Declares optional server website URL metadata.
081         *
082         * @return the server website URL, or an empty string if unspecified
083         */
084    @Nullable
085    String websiteUrl() default "";
086}