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 * Immutable content block carried by an MCP tool result or prompt message.
026 *
027 * <p>
028 * This type may gain reviewed permitted subtypes in Soklet 4.x; use a forward-compatible default when switching over its values.
029 *
030 * @author <a href="https://www.revetkn.com">Mark Allen</a>
031 */
032@ThreadSafe
033public sealed interface McpContentBlock permits McpAudioContent,
034                McpEmbeddedResource, McpImageContent, McpResourceLink, McpTextContent {
035        /**
036         * Returns optional presentation annotations for this content block.
037         *
038         * @return content annotations, if supplied
039         */
040        @NonNull
041        Optional<@NonNull McpContentAnnotations> getAnnotations();
042
043        /**
044         * Returns protocol extension metadata associated with this content block.
045         *
046         * @return immutable extension metadata
047         */
048        @NonNull
049        McpJsonObject getMetadata();
050}