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 javax.annotation.concurrent.ThreadSafe;
020
021/**
022 * Sealed result family for programmatic MCP handlers and handler interception.
023 *
024 * <p>The framework-owned result family includes {@link McpCompleteResult},
025 * {@link McpInputRequiredResult}, {@link McpTaskCreatedResult},
026 * {@link McpResourcePage}, {@link McpSkillPage}, and {@link McpArgumentCompletionResult}.
027 * Applications cannot implement this interface directly. Each MCP method
028 * accepts only its corresponding result implementation; sealing does not make
029 * every permitted result valid for every operation. Future operations
030 * may add framework-owned result types, so callers should retain a default
031 * branch when switching on the result family.
032 *
033 * <p>
034 * This type may gain reviewed permitted subtypes in Soklet 4.x; use a forward-compatible default when switching over its values.
035 *
036 * @author <a href="https://www.revetkn.com">Mark Allen</a>
037 */
038@ThreadSafe
039public sealed interface McpOperationResult permits McpCompleteResult,
040                McpInputRequiredResult, McpTaskCreatedResult, McpResourcePage,
041                McpArgumentCompletionResult, McpSkillPage {
042}