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 * Request-scoped MCP metadata.
026 *
027 * @author <a href="https://www.revetkn.com">Mark Allen</a>
028 */
029@ThreadSafe
030public interface McpRequestContext {
031        /**
032         * Provides the transport request being handled.
033         *
034         * @return the current request
035         */
036        @NonNull
037        Request getRequest();
038
039        /**
040         * Provides the resolved endpoint class for the current request.
041         *
042         * @return the endpoint class
043         */
044        @NonNull
045        Class<? extends McpEndpoint> getEndpointClass();
046
047        /**
048         * Provides the JSON-RPC method name.
049         *
050         * @return the JSON-RPC method
051         */
052        @NonNull
053        String getJsonRpcMethod();
054
055        /**
056         * Provides the high-level MCP operation type.
057         *
058         * @return the operation type
059         */
060        @NonNull
061        McpOperationType getOperationType();
062
063        /**
064         * Provides the JSON-RPC request ID for request-style operations.
065         *
066         * @return the request ID, if available
067         */
068        @NonNull
069        Optional<McpJsonRpcRequestId> getJsonRpcRequestId();
070
071        /**
072         * Provides the MCP session ID associated with the request.
073         *
074         * @return the session ID, if available
075         */
076        @NonNull
077        Optional<String> getSessionId();
078
079        /**
080         * Provides the negotiated protocol version for the request's session.
081         *
082         * @return the negotiated protocol version, if available
083         */
084        @NonNull
085        Optional<String> getProtocolVersion();
086
087        /**
088         * Provides the negotiated server capabilities for the request's session.
089         *
090         * @return the negotiated capabilities, if available
091         */
092        @NonNull
093        Optional<McpNegotiatedCapabilities> getNegotiatedCapabilities();
094
095        /**
096         * Provides the current session context for the request's session.
097         *
098         * @return the session context, if available
099         */
100        @NonNull
101        Optional<McpSessionContext> getSessionContext();
102}