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.Optional;
023
024/**
025 * Programmatic MCP resource-read handler contract.
026 *
027 * @author <a href="https://www.revetkn.com">Mark Allen</a>
028 */
029@ThreadSafe
030public interface McpResourceHandler {
031        /**
032         * Provides the resource URI or URI template handled by this resource.
033         *
034         * @return the resource URI or URI template
035         */
036        @NonNull
037        String getUri();
038
039        /**
040         * Provides the MCP resource name.
041         *
042         * @return the resource name
043         */
044        @NonNull
045        String getName();
046
047        /**
048         * Provides the MIME type returned by this resource handler.
049         *
050         * @return the MIME type
051         */
052        @NonNull
053        String getMimeType();
054
055        /**
056         * Provides optional description metadata for the resource.
057         *
058         * @return the resource description, if available
059         */
060        @NonNull
061        default Optional<String> getDescription() {
062                return Optional.empty();
063        }
064
065        /**
066         * Handles an MCP {@code resources/read} request.
067         *
068         * @param context the resource handler context
069         * @return the resource contents
070         * @throws Exception if the resource read fails
071         */
072        @NonNull
073        McpResourceContents handle(@NonNull McpResourceHandlerContext context) throws Exception;
074}