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;
022
023/**
024 * Application-owned argument completer for a prompt or resource URI template.
025 *
026 * <p>The handler must authorize every suggestion it returns for the admitted
027 * request identity. Context arguments and partial values are untrusted input.
028 * Implementations must be safe for concurrent invocation.
029 *
030 * @author <a href="https://www.revetkn.com">Mark Allen</a>
031 */
032@ThreadSafe
033@FunctionalInterface
034public interface McpCompletionHandler {
035        /**
036         * Supplies ordered suggestions for one partial argument value.
037         *
038         * @param requestContext admitted request metadata
039         * @param completionContext partial argument and canonical registration
040         * @param invocationFeatures invocation-scoped optional features
041         * @return non-null suggestions result
042         * @throws Exception if application handling fails
043         */
044        @NonNull
045        McpArgumentCompletionResult handle(
046                        @NonNull McpRequestContext requestContext,
047                        @NonNull McpCompletionContext completionContext,
048                        @NonNull McpInvocationFeatures invocationFeatures) throws Exception;
049}