001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.rest.server.mcp;
018
019import org.apache.juneau.commons.inject.*;
020
021/**
022 * Application behavior invoked for a {@code completion/complete} request against a declared prompt
023 * argument ({@link McpPromptArgument#getCompleter()}) or resource-template variable
024 * ({@link McpResourceTemplateHandler#completer(String)}).
025 *
026 * <p>
027 * Order and duplicates in the returned {@link McpCompletionResult#getValues() values} are
028 * application-owned: this SPI performs no ranking, filtering, deduplication, or pagination beyond the
029 * 100-value cap documented on {@link McpCompletionResult}.
030 */
031@FunctionalInterface
032public interface McpCompleter {
033
034   /**
035    * Computes completion suggestions for the current value of one prompt argument or template
036    * variable.
037    *
038    * @param request The completion request. Never <jk>null</jk>.
039    * @param ctx Per-request bean store. Never <jk>null</jk>.
040    * @return The completion result. A <jk>null</jk> return is an internal handler failure - see
041    *    {@link McpCompletionResult#normalize(McpCompletionResult)}.
042    */
043   McpCompletionResult complete(McpCompletionRequest request, BeanStore ctx);
044}