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 resource.
028 *
029 * @author <a href="https://www.revetkn.com">Mark Allen</a>
030 */
031@Target(ElementType.METHOD)
032@Retention(RetentionPolicy.RUNTIME)
033public @interface McpResource {
034        /**
035         * Declares the resource URI or URI template.
036         *
037         * @return the resource URI or URI template
038         */
039    String uri();
040
041        /**
042         * Declares the MCP resource name.
043         *
044         * @return the resource name exposed to clients
045         */
046    String name();
047
048        /**
049         * Declares the MIME type returned by the resource-read handler.
050         *
051         * @return the resource MIME type
052         */
053    String mimeType();
054
055        /**
056         * Declares optional resource description metadata.
057         *
058         * @return the resource description, or an empty string if unspecified
059         */
060    @Nullable
061    String description() default "";
062}