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 com.soklet.McpProtocolVersion;
020import org.jspecify.annotations.NonNull;
021
022import java.lang.annotation.ElementType;
023import java.lang.annotation.Retention;
024import java.lang.annotation.RetentionPolicy;
025import java.lang.annotation.Target;
026
027/**
028 * Attaches an argument completer to a resource URI template declared in the
029 * same MCP endpoint. Exact-resource registrations have no declared variables
030 * and cannot have a completer.
031 * Completion supports MCP 2025-06-18, 2025-11-25, and 2026-07-28. The
032 * completer's revisions must be a nonempty subset of the target resource
033 * template's revisions.
034 *
035 * @author <a href="https://www.revetkn.com">Mark Allen</a>
036 */
037@Target(ElementType.METHOD)
038@Retention(RetentionPolicy.RUNTIME)
039public @interface McpResourceCompletion {
040        /** @return the required exact MCP revisions handled by this completer */
041        @NonNull
042        McpProtocolVersion @NonNull [] protocolVersions();
043        /** @return the target resource template's registered URI template */
044        @NonNull
045        String uri();
046}