Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- AbstractMcpServerFactory<Spec,
S, T, C, P, R, U> - Class in io.micronaut.mcp.server -
An abstract factory class responsible for creating MCP server specifications.
- AbstractMcpServerFactory() - Constructor for class io.micronaut.mcp.server.AbstractMcpServerFactory
- addMethod(BeanDefinition<?>, ExecutableMethod<?, ?>) - Method in class io.micronaut.mcp.server.registry.PromptRegistry
-
Adds a new method to the registry by associating it with a given bean definition.
- afterAll(ExtensionContext) - Method in class io.modelcontextprotocol.server.http.tck.SuiteShutdownExtension
- annotations() - Element in annotation interface io.micronaut.mcp.annotations.Tool
-
Additional hints for clients.
- asStringList(Object) - Static method in class io.micronaut.mcp.server.registry.CompletionRegistry
B
- beanContext - Variable in class io.micronaut.mcp.server.registry.PromptRegistry
- build() - Method in class io.micronaut.mcp.server.tools.fetch.FetchResponse.Builder
- build() - Method in class io.micronaut.mcp.server.tools.search.SearchResult.Builder
-
Build the
SearchResult
instance. - builder() - Static method in record class io.micronaut.mcp.server.tools.fetch.FetchResponse
- builder() - Static method in record class io.micronaut.mcp.server.tools.search.SearchResult
-
Create a new builder.
- buildMcpServerSpec(S, McpJsonMapper, JsonSchemaValidator, McpServerInfoConfiguration, ToolsConfiguration, PromptsConfiguration, ResourcesConfiguration, McpSchema.ServerCapabilities.Builder, Provider<McpSchema.ServerCapabilities>, ToolRegistry, PromptRegistry, ResourceRegistry, ResourceTemplateRegistry, CompletionRegistry, List<T>, List<C>, List<P>, List<R>, List<U>) - Method in class io.micronaut.mcp.server.AbstractMcpServerFactory
C
- canMap(Class<? extends Throwable>) - Method in interface io.micronaut.mcp.server.exceptions.McpErrorExceptionMapper
- ClasspathPrompt - Class in io.micronaut.mcp.primitives.prompts
-
EachProperty
to drive the creation of Prompts via configuration. - ClasspathPrompt(String) - Constructor for class io.micronaut.mcp.primitives.prompts.ClasspathPrompt
- closeGracefully() - Method in class io.micronaut.mcp.server.stdio.StdioServerTransportProviderReplacement
- CompletionRegistry - Class in io.micronaut.mcp.server.registry
-
The registry of
PromptCompletion
andResourceCompletion
. - createDefault() - Static method in interface io.micronaut.mcp.server.McpHttpServer
-
Creates a new default
McpHttpServer
. - createMcpServerSpec(S, McpJsonMapper, JsonSchemaValidator, McpServerInfoConfiguration, McpSchema.ServerCapabilities, List<T>, List<C>, List<P>, List<R>, List<U>) - Method in class io.micronaut.mcp.server.AbstractMcpServerFactory
-
Creates an MCP server specification based on the provided parameters.
D
- DEFAULT_DESCRIPTION - Static variable in interface io.micronaut.mcp.server.tools.fetch.FetchTool
- DEFAULT_DESCRIPTION - Static variable in interface io.micronaut.mcp.server.tools.search.SearchTool
- DEFAULT_ENABLED - Static variable in interface io.micronaut.mcp.conf.client.McpClientConfiguration
- DEFAULT_ENABLED - Static variable in interface io.micronaut.mcp.conf.server.McpServerConfiguration
- DEFAULT_ENDPOINT - Static variable in interface io.micronaut.mcp.conf.server.McpServerConfiguration
- DEFAULT_IDEMPOTENT_HINT_VALUE - Static variable in class io.micronaut.mcp.server.registry.ToolRegistry
- DEFAULT_LIST_CHANGED - Static variable in interface io.micronaut.mcp.conf.server.McpPrimitiveConfiguration
- DEFAULT_MIME_TYPE - Static variable in annotation interface io.micronaut.mcp.annotations.Resource
- DEFAULT_MIME_TYPE - Static variable in annotation interface io.micronaut.mcp.annotations.ResourceTemplate
- DEFAULT_NAME - Static variable in interface io.micronaut.mcp.server.tools.fetch.FetchTool
- DEFAULT_NAME - Static variable in interface io.micronaut.mcp.server.tools.search.SearchTool
- DEFAULT_OPEN_WORLD_HINT_VALUE - Static variable in class io.micronaut.mcp.server.registry.ToolRegistry
- DEFAULT_REACTIVE - Static variable in interface io.micronaut.mcp.conf.server.McpServerConfiguration
- DEFAULT_RETURN_DIRECT_VALUE - Static variable in class io.micronaut.mcp.server.registry.ToolRegistry
- DEFAULT_SUBSCRIBE - Static variable in interface io.micronaut.mcp.conf.server.ResourcesConfiguration
- DEFAULT_TITLE - Static variable in interface io.micronaut.mcp.server.tools.fetch.FetchTool
- DEFAULT_TITLE - Static variable in interface io.micronaut.mcp.server.tools.search.SearchTool
- DEFAULT_TRANSPORT - Static variable in interface io.micronaut.mcp.conf.client.McpClientConfiguration
- DEFAULT_TRANSPORT - Static variable in interface io.micronaut.mcp.conf.server.McpServerConfiguration
- description() - Element in annotation interface io.micronaut.mcp.annotations.Prompt
- description() - Element in annotation interface io.micronaut.mcp.annotations.PromptArg
- description() - Element in annotation interface io.micronaut.mcp.annotations.Resource
- description() - Element in annotation interface io.micronaut.mcp.annotations.ResourceTemplate
- description() - Element in annotation interface io.micronaut.mcp.annotations.Tool
- description() - Element in annotation interface io.micronaut.mcp.annotations.ToolArg
-
The description of the tool argument.
- DESCRIPTION_PROPERTY - Static variable in class io.micronaut.mcp.server.registry.PromptRegistry
- destructiveHint() - Element in annotation interface io.micronaut.mcp.annotations.Tool.ToolAnnotations
- drainMethods() - Method in class io.micronaut.mcp.server.registry.PromptRegistry
-
Returns a stream of the methods currently stored in the registry.
E
- ELEMENT_NAME - Static variable in annotation interface io.micronaut.mcp.annotations.Prompt
-
Constant value for
Prompt.name()
indicating that the annotated element's name should be used as-is. - ELEMENT_NAME - Static variable in annotation interface io.micronaut.mcp.annotations.PromptArg
-
Constant value for
PromptArg.name()
indicating that the annotated element's name should be used as-is. - ELEMENT_NAME - Static variable in annotation interface io.micronaut.mcp.annotations.PromptCompletion
-
Constant value for
PromptCompletion.name()
indicating that the annotated element's name should be used as-is. - ELEMENT_NAME - Static variable in annotation interface io.micronaut.mcp.annotations.Resource
-
Constant value for
Resource.name()
indicating that the annotated element's name should be used as-is. - ELEMENT_NAME - Static variable in annotation interface io.micronaut.mcp.annotations.ResourceTemplate
-
Constant value for
ResourceTemplate.name()
indicating that the annotated element's name should be used as-is. - ELEMENT_NAME - Static variable in annotation interface io.micronaut.mcp.annotations.Tool
-
Constant value for
Tool.name()
indicating that the annotated element's name should be used as-is. - ELEMENT_NAME - Static variable in annotation interface io.micronaut.mcp.annotations.ToolArg
-
Constant value for
ToolArg.name()
indicating that the annotated element's name should be used as-is. - equals(Object) - Method in record class io.micronaut.mcp.server.tools.fetch.FetchRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.micronaut.mcp.server.tools.fetch.FetchResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.micronaut.mcp.server.tools.search.SearchRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.micronaut.mcp.server.tools.search.SearchResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.micronaut.mcp.server.tools.search.SearchResult
-
Indicates whether some other object is "equal to" this one.
F
- fetch(FetchRequest, McpTransportContext) - Method in interface io.micronaut.mcp.server.tools.fetch.FetchTool
-
The fetch tool is used to retrieve the full contents of a search result document or item.
- FetchRequest - Record Class in io.micronaut.mcp.server.tools.fetch
-
Input of the fetch tool, which is used to retrieve the full contents of a search result document or item.
- FetchRequest(String) - Constructor for record class io.micronaut.mcp.server.tools.fetch.FetchRequest
-
Creates an instance of a
FetchRequest
record class. - FetchResponse - Record Class in io.micronaut.mcp.server.tools.fetch
- FetchResponse(String, String, String, String, Map<String, Object>) - Constructor for record class io.micronaut.mcp.server.tools.fetch.FetchResponse
-
Creates an instance of a
FetchResponse
record class. - FetchResponse.Builder - Class in io.micronaut.mcp.server.tools.fetch
-
Fetch Response Builder.
- FetchTool - Interface in io.micronaut.mcp.server.tools.fetch
-
Tool which retrieves the full contents of a search result document or item.
G
- get() - Method in class io.micronaut.mcp.server.json.MicronautMcpJsonMapperSupplier
- getArguments() - Method in class io.micronaut.mcp.primitives.prompts.ClasspathPrompt
- getAsyncSpecs() - Method in class io.micronaut.mcp.server.registry.CompletionRegistry
- getAsyncSpecs() - Method in class io.micronaut.mcp.server.registry.PromptRegistry
- getAsyncSpecs() - Method in class io.micronaut.mcp.server.registry.ResourceRegistry
- getAsyncSpecs() - Method in class io.micronaut.mcp.server.registry.ResourceTemplateRegistry
- getAsyncSpecs() - Method in class io.micronaut.mcp.server.registry.ToolRegistry
- getCommands() - Method in interface io.micronaut.mcp.client.langchain4j.stdio.StdioMcpTransportConfiguration
- getCompletions(CompletionRegistry) - Method in class io.micronaut.mcp.server.AbstractMcpServerFactory
-
Retrieves a list of completions from the provided
CompletionRegistry
. - getDefault() - Static method in interface io.micronaut.mcp.server.McpHttpServer
-
Returns the default
McpHttpServer
. - getDescription() - Method in class io.micronaut.mcp.primitives.prompts.ClasspathPrompt
- getDescription() - Method in class io.micronaut.mcp.primitives.prompts.PromptArgument
- getDescription() - Method in interface io.micronaut.mcp.server.tools.fetch.FetchTool
- getDescription() - Method in interface io.micronaut.mcp.server.tools.search.SearchTool
- getEndpoint() - Method in interface io.micronaut.mcp.conf.server.McpServerConfiguration
- getEndpoint() - Method in interface io.micronaut.mcp.server.McpHttpServer
- getName() - Method in interface io.micronaut.mcp.conf.server.McpServerInfoConfiguration
- getName() - Method in class io.micronaut.mcp.primitives.prompts.ClasspathPrompt
- getName() - Method in class io.micronaut.mcp.primitives.prompts.PromptArgument
- getName() - Method in interface io.micronaut.mcp.server.tools.fetch.FetchTool
- getName() - Method in interface io.micronaut.mcp.server.tools.search.SearchTool
- getNameQualifier() - Method in class io.micronaut.mcp.primitives.prompts.ClasspathPrompt
- getPath() - Method in class io.micronaut.mcp.primitives.prompts.ClasspathPrompt
- getPort() - Method in interface io.micronaut.mcp.server.McpHttpServer
- getPrompts(PromptRegistry) - Method in class io.micronaut.mcp.server.AbstractMcpServerFactory
-
Retrieves a list of prompts from the provided
PromptRegistry
. - getResources(ResourceRegistry) - Method in class io.micronaut.mcp.server.AbstractMcpServerFactory
-
Retrieves a list of resources from the provided
ResourceRegistry
. - getResourceTemplates(ResourceTemplateRegistry) - Method in class io.micronaut.mcp.server.AbstractMcpServerFactory
-
Retrieves a list of resources templates from the provided
ResourceTemplateRegistry
. - getStatelessAsyncSpecs() - Method in class io.micronaut.mcp.server.registry.CompletionRegistry
- getStatelessAsyncSpecs() - Method in class io.micronaut.mcp.server.registry.PromptRegistry
- getStatelessAsyncSpecs() - Method in class io.micronaut.mcp.server.registry.ResourceRegistry
- getStatelessAsyncSpecs() - Method in class io.micronaut.mcp.server.registry.ResourceTemplateRegistry
- getStatelessAsyncSpecs() - Method in class io.micronaut.mcp.server.registry.ToolRegistry
- getStatelessSyncSpecs() - Method in class io.micronaut.mcp.server.registry.CompletionRegistry
- getStatelessSyncSpecs() - Method in class io.micronaut.mcp.server.registry.PromptRegistry
- getStatelessSyncSpecs() - Method in class io.micronaut.mcp.server.registry.ResourceRegistry
- getStatelessSyncSpecs() - Method in class io.micronaut.mcp.server.registry.ResourceTemplateRegistry
- getStatelessSyncSpecs() - Method in class io.micronaut.mcp.server.registry.ToolRegistry
- getSyncSpecs() - Method in class io.micronaut.mcp.server.registry.CompletionRegistry
- getSyncSpecs() - Method in class io.micronaut.mcp.server.registry.PromptRegistry
- getSyncSpecs() - Method in class io.micronaut.mcp.server.registry.ResourceRegistry
- getSyncSpecs() - Method in class io.micronaut.mcp.server.registry.ResourceTemplateRegistry
- getSyncSpecs() - Method in class io.micronaut.mcp.server.registry.ToolRegistry
- getTimeout() - Method in interface io.micronaut.mcp.conf.client.McpClientHttpConfiguration
- getTitle() - Method in class io.micronaut.mcp.primitives.prompts.ClasspathPrompt
- getTitle() - Method in class io.micronaut.mcp.primitives.prompts.PromptArgument
- getTitle() - Method in interface io.micronaut.mcp.server.tools.fetch.FetchTool
- getTitle() - Method in interface io.micronaut.mcp.server.tools.search.SearchTool
- getTools(ToolRegistry) - Method in class io.micronaut.mcp.server.AbstractMcpServerFactory
-
Retrieves a list of tools from the provided
ToolRegistry
. - getTransport() - Method in interface io.micronaut.mcp.conf.client.McpClientConfiguration
- getTransport() - Method in interface io.micronaut.mcp.conf.server.McpServerConfiguration
- getUrl() - Method in interface io.micronaut.mcp.conf.client.McpClientHttpConfiguration
- getVersion() - Method in interface io.micronaut.mcp.conf.server.McpServerInfoConfiguration
H
- hashCode() - Method in record class io.micronaut.mcp.server.tools.fetch.FetchRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.micronaut.mcp.server.tools.fetch.FetchResponse
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.micronaut.mcp.server.tools.search.SearchRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.micronaut.mcp.server.tools.search.SearchResponse
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.micronaut.mcp.server.tools.search.SearchResult
-
Returns a hash code value for this object.
- host() - Method in interface io.micronaut.mcp.server.context.MicronautMcpTransportContext
- HTTP - Enum constant in enum class io.micronaut.mcp.conf.Transport
- HttpRequestUtils - Class in io.modelcontextprotocol.server.http.tck
-
Utils class to instantiate
HttpRequest
s.
I
- id() - Method in record class io.micronaut.mcp.server.tools.fetch.FetchRequest
-
Returns the value of the
id
record component. - id() - Method in record class io.micronaut.mcp.server.tools.fetch.FetchResponse
-
Returns the value of the
id
record component. - id() - Method in record class io.micronaut.mcp.server.tools.search.SearchResult
-
Returns the value of the
id
record component. - id(String) - Method in class io.micronaut.mcp.server.tools.fetch.FetchResponse.Builder
- id(String) - Method in class io.micronaut.mcp.server.tools.search.SearchResult.Builder
-
Set the id.
- idempotentHint() - Element in annotation interface io.micronaut.mcp.annotations.Tool.ToolAnnotations
- InitializeTest - Class in io.modelcontextprotocol.server.http.tck
-
MCP Server Initialization Phase.
- InitializeTest() - Constructor for class io.modelcontextprotocol.server.http.tck.InitializeTest
- interpolate(String, Map<String, Object>) - Static method in class io.micronaut.mcp.primitives.utils.StringInterpolator
-
If you supplied a template such as `Name: ${firstName} ${lastName}` and map of values such as `[firstName: Sergio, lastName: Amo] it returns `Name: Sergio Amo`.
- io.micronaut.mcp.annotations - package io.micronaut.mcp.annotations
- io.micronaut.mcp.client.langchain4j.stdio - package io.micronaut.mcp.client.langchain4j.stdio
-
Classes related with Langchain4J MCP Client and stdio transport.
- io.micronaut.mcp.conf - package io.micronaut.mcp.conf
-
MCP Configuration related classes.
- io.micronaut.mcp.conf.client - package io.micronaut.mcp.conf.client
-
MCP Client Configuration related classes.
- io.micronaut.mcp.conf.server - package io.micronaut.mcp.conf.server
-
MCP Configuration classes.
- io.micronaut.mcp.primitives.prompts - package io.micronaut.mcp.primitives.prompts
- io.micronaut.mcp.primitives.utils - package io.micronaut.mcp.primitives.utils
- io.micronaut.mcp.server - package io.micronaut.mcp.server
-
Micronaut MCP Server implementation built with Micronaut using the MCP Java SDK.
- io.micronaut.mcp.server.context - package io.micronaut.mcp.server.context
- io.micronaut.mcp.server.exceptions - package io.micronaut.mcp.server.exceptions
- io.micronaut.mcp.server.json - package io.micronaut.mcp.server.json
-
Classes for JSON serialization for MCP Java SDK.
- io.micronaut.mcp.server.registry - package io.micronaut.mcp.server.registry
- io.micronaut.mcp.server.stdio - package io.micronaut.mcp.server.stdio
-
Classes related to
McpAsyncServer
andMcpSyncServer
and stdio transport. - io.micronaut.mcp.server.tools.fetch - package io.micronaut.mcp.server.tools.fetch
-
Classes related with fetch tool.
- io.micronaut.mcp.server.tools.search - package io.micronaut.mcp.server.tools.search
-
Classes related with search tool.
- io.modelcontextprotocol.server.http.tck - package io.modelcontextprotocol.server.http.tck
- isListChanged() - Method in interface io.micronaut.mcp.conf.server.McpPrimitiveConfiguration
- isListChanged() - Method in interface io.micronaut.mcp.conf.server.PromptsConfiguration
- isListChanged() - Method in interface io.micronaut.mcp.conf.server.ResourcesConfiguration
- isListChanged() - Method in interface io.micronaut.mcp.conf.server.ToolsConfiguration
- isLogRequests() - Method in interface io.micronaut.mcp.conf.client.McpClientHttpConfiguration
- isLogResponses() - Method in interface io.micronaut.mcp.conf.client.McpClientHttpConfiguration
- isNotEmpty() - Method in class io.micronaut.mcp.server.registry.CompletionRegistry
- isNotEmpty() - Method in class io.micronaut.mcp.server.registry.PromptRegistry
- isNotEmpty() - Method in class io.micronaut.mcp.server.registry.ResourceRegistry
- isNotEmpty() - Method in class io.micronaut.mcp.server.registry.ResourceTemplateRegistry
- isNotEmpty() - Method in class io.micronaut.mcp.server.registry.ToolRegistry
- isReactive() - Method in interface io.micronaut.mcp.conf.server.McpServerConfiguration
- isRequired() - Method in class io.micronaut.mcp.primitives.prompts.PromptArgument
- isSubscribe() - Method in interface io.micronaut.mcp.conf.server.ResourcesConfiguration
J
- jsonrpcResponse(McpError, McpSchema.JSONRPCMessage) - Static method in class io.micronaut.mcp.server.exceptions.JsonRrpcResponseUtils
-
If the MCP error is related to a listing request to a primitive, it returns an empty response for that primitive instead of an error.
- JsonRrpcResponseUtils - Class in io.micronaut.mcp.server.exceptions
-
Utility class to generate
McpSchema.JSONRPCResponse
s allowing the gracious handling of MCP errors for primitive listings.
K
- KEY_TYPE - Static variable in class io.micronaut.mcp.server.registry.PromptRegistry
L
- lastEventId() - Method in interface io.micronaut.mcp.server.context.MicronautMcpTransportContext
- locale() - Method in interface io.micronaut.mcp.server.context.MicronautMcpTransportContext
M
- map(McpSchema.JSONRPCResponse) - Static method in class io.micronaut.mcp.server.exceptions.JsonRrpcResponseUtils
-
If the JSONRPCResponse signals an error and the error is related to a listing request to a primitive, it returns an empty response for that primitive instead of an error.
- map(T) - Method in interface io.micronaut.mcp.server.exceptions.McpErrorExceptionMapper
-
Map the given exception to a
McpError
. - McpClientConfiguration - Interface in io.micronaut.mcp.conf.client
-
MCP Client Configuration.
- McpClientHttpConfiguration - Interface in io.micronaut.mcp.conf.client
-
MCP Client HTTP Configuration.
- mcpError(Exception) - Method in class io.micronaut.mcp.server.registry.PromptRegistry
- McpErrorExceptionMapper<T extends Throwable> - Interface in io.micronaut.mcp.server.exceptions
-
ApI to define mappers from exceptions to
McpError
. - McpHttpServer - Interface in io.micronaut.mcp.server
-
An MCP Server.
- McpHttpServerSupplier - Interface in io.micronaut.mcp.server
-
Strategy interface for resolving a
McpHttpServer
. - McpPrimitive - Annotation Interface in io.micronaut.mcp.annotations
-
Marker to indicate that an annotation is an MCP Primitive.
- McpPrimitiveConfiguration - Interface in io.micronaut.mcp.conf.server
-
MCP Primitive configuration.
- McpServerConfiguration - Interface in io.micronaut.mcp.conf.server
-
MCP Server Configuration.
- McpServerInfoConfiguration - Interface in io.micronaut.mcp.conf.server
-
MCP Server Info Configuration.
- MEMBER_DESCRIPTION - Static variable in class io.micronaut.mcp.server.registry.PromptRegistry
- MEMBER_NAME - Static variable in class io.micronaut.mcp.server.registry.PromptRegistry
- MEMBER_TITLE - Static variable in class io.micronaut.mcp.server.registry.PromptRegistry
- metadata() - Method in record class io.micronaut.mcp.server.tools.fetch.FetchResponse
-
Returns the value of the
metadata
record component. - metadata(Map<String, Object>) - Method in class io.micronaut.mcp.server.tools.fetch.FetchResponse.Builder
- methods - Variable in class io.micronaut.mcp.server.registry.PromptRegistry
- MicronautJsonSchemaValidator - Class in io.micronaut.mcp.server.json
-
MCP
JsonSchemaValidator
backed by Micronaut JSON Schema ValidatorJsonSchemaValidator
. - MicronautJsonSchemaValidator(JsonMapper, JsonSchemaValidator) - Constructor for class io.micronaut.mcp.server.json.MicronautJsonSchemaValidator
- MicronautMcpJsonMapperSupplier - Class in io.micronaut.mcp.server.json
-
A Micronaut implementation of
McpJsonMapperSupplier
that provides aMicronautMcpJsonMapper
. - MicronautMcpJsonMapperSupplier() - Constructor for class io.micronaut.mcp.server.json.MicronautMcpJsonMapperSupplier
- MicronautMcpTransportContext - Interface in io.micronaut.mcp.server.context
-
Extension of
McpTransportContext
with convenience methods to access common transport metadata in a Micronaut context. - MIME_TYPE_PROPERTY - Static variable in class io.micronaut.mcp.server.registry.PromptRegistry
- mimeType() - Element in annotation interface io.micronaut.mcp.annotations.Resource
- mimeType() - Element in annotation interface io.micronaut.mcp.annotations.ResourceTemplate
N
- name() - Element in annotation interface io.micronaut.mcp.annotations.Prompt
- name() - Element in annotation interface io.micronaut.mcp.annotations.PromptArg
- name() - Element in annotation interface io.micronaut.mcp.annotations.PromptCompletion
- name() - Element in annotation interface io.micronaut.mcp.annotations.Resource
- name() - Element in annotation interface io.micronaut.mcp.annotations.ResourceTemplate
- name() - Element in annotation interface io.micronaut.mcp.annotations.Tool
-
Each tool must have a unique name.
- name() - Element in annotation interface io.micronaut.mcp.annotations.ToolArg
-
The name of the tool argument.
- NAME_PROPERTY - Static variable in class io.micronaut.mcp.server.registry.PromptRegistry
- notifyClients(String, Object) - Method in class io.micronaut.mcp.server.stdio.StdioServerTransportProviderReplacement
O
- of(String, URI) - Static method in interface io.micronaut.mcp.conf.client.McpClientHttpConfiguration
- openWorldHint() - Element in annotation interface io.micronaut.mcp.annotations.Tool.ToolAnnotations
P
- PING - Static variable in class io.modelcontextprotocol.server.http.tck.PingTest
- PingTest - Class in io.modelcontextprotocol.server.http.tck
-
MCP Server Ping.
- PingTest() - Constructor for class io.modelcontextprotocol.server.http.tck.PingTest
- PONG - Static variable in class io.modelcontextprotocol.server.http.tck.PingTest
- POST(McpHttpServer, String) - Static method in class io.modelcontextprotocol.server.http.tck.HttpRequestUtils
- PREFIX - Static variable in interface io.micronaut.mcp.client.langchain4j.stdio.StdioMcpTransportConfiguration
- PREFIX - Static variable in interface io.micronaut.mcp.conf.client.McpClientConfiguration
- PREFIX - Static variable in interface io.micronaut.mcp.conf.client.McpClientHttpConfiguration
- PREFIX - Static variable in interface io.micronaut.mcp.conf.server.McpServerConfiguration
- PREFIX - Static variable in interface io.micronaut.mcp.conf.server.McpServerInfoConfiguration
-
MCP Server Info configuration Prefix.
- PREFIX - Static variable in interface io.micronaut.mcp.conf.server.PromptsConfiguration
- PREFIX - Static variable in interface io.micronaut.mcp.conf.server.ResourcesConfiguration
- PREFIX - Static variable in interface io.micronaut.mcp.conf.server.ToolsConfiguration
- prepareBoundVariables(ExecutableMethod<?, ?>, List<?>) - Method in class io.micronaut.mcp.server.registry.PromptRegistry
- principal() - Method in interface io.micronaut.mcp.server.context.MicronautMcpTransportContext
- Prompt - Annotation Interface in io.micronaut.mcp.annotations
-
Method annotation to define an MCP Prompt.
- PromptArg - Annotation Interface in io.micronaut.mcp.annotations
-
Annotates a parameter of a
Prompt
method. - PromptArgument - Class in io.micronaut.mcp.primitives.prompts
-
An MCP Prompt Argument.
- PromptArgument() - Constructor for class io.micronaut.mcp.primitives.prompts.PromptArgument
- PromptCompletion - Annotation Interface in io.micronaut.mcp.annotations
-
Method annotation to define an MCP Prompt Completion.
- PromptRegistry - Class in io.micronaut.mcp.server.registry
-
The registry of
Prompt
s. - PROMPTS_GET - Static variable in class io.modelcontextprotocol.server.http.tck.PromptsGetTest
- PROMPTS_GET_RESULT - Static variable in class io.modelcontextprotocol.server.http.tck.PromptsGetTest
- PROMPTS_LIST - Static variable in class io.modelcontextprotocol.server.http.tck.PromptsListTest
- PROMPTS_LIST_RESULT - Static variable in class io.modelcontextprotocol.server.http.tck.PromptsListTest
- PromptsConfiguration - Interface in io.micronaut.mcp.conf.server
-
MCP Resources configuration.
- PromptsGetTest - Class in io.modelcontextprotocol.server.http.tck
-
MCP Server Getting a Prompt.
- PromptsGetTest() - Constructor for class io.modelcontextprotocol.server.http.tck.PromptsGetTest
- PromptsListTest - Class in io.modelcontextprotocol.server.http.tck
-
MCP Server Prompts.
- PromptsListTest() - Constructor for class io.modelcontextprotocol.server.http.tck.PromptsListTest
- PROPERTY_COMMANDS - Static variable in interface io.micronaut.mcp.client.langchain4j.stdio.StdioMcpTransportConfiguration
- PROPERTY_ENABLED - Static variable in interface io.micronaut.mcp.conf.client.McpClientConfiguration
- PROPERTY_ENABLED - Static variable in interface io.micronaut.mcp.conf.server.McpServerConfiguration
- PROPERTY_ENDPOINT - Static variable in interface io.micronaut.mcp.conf.server.McpServerConfiguration
- PROPERTY_NAME - Static variable in interface io.micronaut.mcp.conf.server.McpServerInfoConfiguration
-
configuration property name for MCP Server name.
- PROPERTY_REACTIVE - Static variable in interface io.micronaut.mcp.conf.server.McpServerConfiguration
- PROPERTY_TRANSPORT - Static variable in interface io.micronaut.mcp.conf.client.McpClientConfiguration
- PROPERTY_TRANSPORT - Static variable in interface io.micronaut.mcp.conf.server.McpServerConfiguration
- PROPERTY_VERSION - Static variable in interface io.micronaut.mcp.conf.server.McpServerInfoConfiguration
-
configuration property name for an MCP Server version.
- protocolVersion() - Method in interface io.micronaut.mcp.server.context.MicronautMcpTransportContext
- protocolVersions() - Method in class io.micronaut.mcp.server.stdio.StdioServerTransportProviderReplacement
Q
- query() - Method in record class io.micronaut.mcp.server.tools.search.SearchRequest
-
Returns the value of the
query
record component.
R
- readOnlyHint() - Element in annotation interface io.micronaut.mcp.annotations.Tool.ToolAnnotations
- resolveMcpTransportContext(Object) - Method in class io.micronaut.mcp.server.registry.PromptRegistry
- Resource - Annotation Interface in io.micronaut.mcp.annotations
-
Method annotation to define an MCP Resource handler.
- ResourceCompletion - Annotation Interface in io.micronaut.mcp.annotations
-
Method annotation to define an MCP Resource Completion.
- ResourceRegistry - Class in io.micronaut.mcp.server.registry
-
The registry of
Resource
-annotated methods. - ResourceRegistry(List<McpErrorExceptionMapper<? extends Throwable>>, ArgumentBinderRegistry<McpSchema.ReadResourceRequest>, BeanContext) - Constructor for class io.micronaut.mcp.server.registry.ResourceRegistry
- RESOURCES_GET - Static variable in class io.modelcontextprotocol.server.http.tck.ResourcesGetTest
- RESOURCES_GET_RESULT - Static variable in class io.modelcontextprotocol.server.http.tck.ResourcesGetTest
- RESOURCES_LIST - Static variable in class io.modelcontextprotocol.server.http.tck.ResourcesListTest
- RESOURCES_LIST_RESULT - Static variable in class io.modelcontextprotocol.server.http.tck.ResourcesListTest
- ResourcesConfiguration - Interface in io.micronaut.mcp.conf.server
-
MCP Resources configuration.
- ResourcesGetTest - Class in io.modelcontextprotocol.server.http.tck
-
MCP Server Resources List.
- ResourcesGetTest() - Constructor for class io.modelcontextprotocol.server.http.tck.ResourcesGetTest
- ResourcesListTest - Class in io.modelcontextprotocol.server.http.tck
-
MCP Server Resources List.
- ResourcesListTest() - Constructor for class io.modelcontextprotocol.server.http.tck.ResourcesListTest
- ResourceTemplate - Annotation Interface in io.micronaut.mcp.annotations
-
Method annotation to define an MCP Resource Template handler.
- ResourceTemplateRegistry - Class in io.micronaut.mcp.server.registry
-
The registry of
ResourceTemplate
-annotated methods. - results() - Method in record class io.micronaut.mcp.server.tools.search.SearchResponse
-
Returns the value of the
results
record component. - returnDirect() - Element in annotation interface io.micronaut.mcp.annotations.Tool.ToolAnnotations
S
- search(SearchRequest, McpTransportContext) - Method in interface io.micronaut.mcp.server.tools.search.SearchTool
- SearchRequest - Record Class in io.micronaut.mcp.server.tools.search
- SearchRequest(String) - Constructor for record class io.micronaut.mcp.server.tools.search.SearchRequest
-
Creates an instance of a
SearchRequest
record class. - SearchResponse - Record Class in io.micronaut.mcp.server.tools.search
- SearchResponse(List<SearchResult>) - Constructor for record class io.micronaut.mcp.server.tools.search.SearchResponse
-
Creates an instance of a
SearchResponse
record class. - SearchResult - Record Class in io.micronaut.mcp.server.tools.search
- SearchResult(String, String, String) - Constructor for record class io.micronaut.mcp.server.tools.search.SearchResult
-
Creates an instance of a
SearchResult
record class. - SearchResult.Builder - Class in io.micronaut.mcp.server.tools.search
-
Fluent builder for
SearchResult
. - SearchTool - Interface in io.micronaut.mcp.server.tools.search
-
The search tool is responsible for returning a list of relevant search results from your MCP server's data source, given a user's query.
- sessionId() - Method in interface io.micronaut.mcp.server.context.MicronautMcpTransportContext
- setArguments(List<PromptArgument>) - Method in class io.micronaut.mcp.primitives.prompts.ClasspathPrompt
- setDescription(String) - Method in class io.micronaut.mcp.primitives.prompts.ClasspathPrompt
- setDescription(String) - Method in class io.micronaut.mcp.primitives.prompts.PromptArgument
- setName(String) - Method in class io.micronaut.mcp.primitives.prompts.ClasspathPrompt
- setName(String) - Method in class io.micronaut.mcp.primitives.prompts.PromptArgument
- setNameQualifier(String) - Method in class io.micronaut.mcp.primitives.prompts.ClasspathPrompt
- setPath(String) - Method in class io.micronaut.mcp.primitives.prompts.ClasspathPrompt
- setRequired(boolean) - Method in class io.micronaut.mcp.primitives.prompts.PromptArgument
- setSessionFactory(McpServerSession.Factory) - Method in class io.micronaut.mcp.server.stdio.StdioServerTransportProviderReplacement
- setTitle(String) - Method in class io.micronaut.mcp.primitives.prompts.ClasspathPrompt
- setTitle(String) - Method in class io.micronaut.mcp.primitives.prompts.PromptArgument
- start() - Method in interface io.micronaut.mcp.server.McpHttpServer
-
Starts the MCP Server.
- STDIO - Enum constant in enum class io.micronaut.mcp.conf.Transport
- StdioMcpTransportConfiguration - Interface in io.micronaut.mcp.client.langchain4j.stdio
-
Configuration for STDIO MCP Transport for Langchain4j MCP Client.
- StdioServerTransportProviderReplacement - Class in io.micronaut.mcp.server.stdio
-
Replacement for the MCP Java SDK
StdioTransportProvider
. - StdioServerTransportProviderReplacement(McpJsonMapper) - Constructor for class io.micronaut.mcp.server.stdio.StdioServerTransportProviderReplacement
-
Creates a new StdioServerTransportProvider with the specified ObjectMapper and System streams.
- StdioServerTransportProviderReplacement(McpJsonMapper, InputStream, OutputStream) - Constructor for class io.micronaut.mcp.server.stdio.StdioServerTransportProviderReplacement
-
Creates a new StdioServerTransportProvider with the specified ObjectMapper and streams.
- StringInterpolator - Class in io.micronaut.mcp.primitives.utils
-
Utility class to perform string interpolation with maps.
- SuiteShutdownExtension - Class in io.modelcontextprotocol.server.http.tck
-
Global JUnit Jupiter extension that closes the default McpHttpServer once the entire test plan (suite) finishes.
- SuiteShutdownExtension() - Constructor for class io.modelcontextprotocol.server.http.tck.SuiteShutdownExtension
T
- text() - Method in record class io.micronaut.mcp.server.tools.fetch.FetchResponse
-
Returns the value of the
text
record component. - text(String) - Method in class io.micronaut.mcp.server.tools.fetch.FetchResponse.Builder
- title() - Element in annotation interface io.micronaut.mcp.annotations.Prompt
-
A human-readable name for this prompt.
- title() - Element in annotation interface io.micronaut.mcp.annotations.Resource
- title() - Element in annotation interface io.micronaut.mcp.annotations.ResourceTemplate
- title() - Element in annotation interface io.micronaut.mcp.annotations.Tool
- title() - Element in annotation interface io.micronaut.mcp.annotations.Tool.ToolAnnotations
- title() - Method in record class io.micronaut.mcp.server.tools.fetch.FetchResponse
-
Returns the value of the
title
record component. - title() - Method in record class io.micronaut.mcp.server.tools.search.SearchResult
-
Returns the value of the
title
record component. - title(String) - Method in class io.micronaut.mcp.server.tools.fetch.FetchResponse.Builder
- title(String) - Method in class io.micronaut.mcp.server.tools.search.SearchResult.Builder
-
Set the title.
- TITLE_PROPERTY - Static variable in class io.micronaut.mcp.server.registry.PromptRegistry
- Tool - Annotation Interface in io.micronaut.mcp.annotations
-
Method annotation to define an MCP Tool.
- Tool.ToolAnnotations - Annotation Interface in io.micronaut.mcp.annotations
-
Additional hints for clients.
- ToolArg - Annotation Interface in io.micronaut.mcp.annotations
-
Annotates a parameter of a
Tool
method. - ToolRegistry - Class in io.micronaut.mcp.server.registry
-
The registry of
Tool
s. - TOOLS_CALL - Static variable in class io.modelcontextprotocol.server.http.tck.ToolsCallTest
- TOOLS_CALL_RESULT - Static variable in class io.modelcontextprotocol.server.http.tck.ToolsCallTest
- TOOLS_LIST - Static variable in class io.modelcontextprotocol.server.http.tck.ToolsTest
- TOOLS_LIST_RESULT - Static variable in class io.modelcontextprotocol.server.http.tck.ToolsTest
- ToolsCallTest - Class in io.modelcontextprotocol.server.http.tck
-
MCP Server Tools Call.
- ToolsCallTest() - Constructor for class io.modelcontextprotocol.server.http.tck.ToolsCallTest
- ToolsConfiguration - Interface in io.micronaut.mcp.conf.server
-
MCP Tools configuration.
- ToolsTest - Class in io.modelcontextprotocol.server.http.tck
-
MCP Server Tools.
- ToolsTest() - Constructor for class io.modelcontextprotocol.server.http.tck.ToolsTest
- toString() - Method in record class io.micronaut.mcp.server.tools.fetch.FetchRequest
-
Returns a string representation of this record class.
- toString() - Method in record class io.micronaut.mcp.server.tools.fetch.FetchResponse
-
Returns a string representation of this record class.
- toString() - Method in record class io.micronaut.mcp.server.tools.search.SearchRequest
-
Returns a string representation of this record class.
- toString() - Method in record class io.micronaut.mcp.server.tools.search.SearchResponse
-
Returns a string representation of this record class.
- toString() - Method in record class io.micronaut.mcp.server.tools.search.SearchResult
-
Returns a string representation of this record class.
- Transport - Enum Class in io.micronaut.mcp.conf
-
Type of MCP Transport.
- TRANSPORT_HTTP - Static variable in interface io.micronaut.mcp.conf.client.McpClientConfiguration
- TRANSPORT_HTTP - Static variable in interface io.micronaut.mcp.conf.server.McpServerConfiguration
- TRANSPORT_STDIO - Static variable in interface io.micronaut.mcp.conf.client.McpClientConfiguration
- TRANSPORT_STDIO - Static variable in interface io.micronaut.mcp.conf.server.McpServerConfiguration
U
- uri() - Element in annotation interface io.micronaut.mcp.annotations.Resource
- uri() - Element in annotation interface io.micronaut.mcp.annotations.ResourceCompletion
- URI_PROPERTY - Static variable in class io.micronaut.mcp.server.registry.PromptRegistry
- URI_TEMPLATE_PROPERTY - Static variable in class io.micronaut.mcp.server.registry.PromptRegistry
- uriTemplate() - Element in annotation interface io.micronaut.mcp.annotations.ResourceTemplate
- url() - Method in record class io.micronaut.mcp.server.tools.fetch.FetchResponse
-
Returns the value of the
url
record component. - url() - Method in record class io.micronaut.mcp.server.tools.search.SearchResult
-
Returns the value of the
url
record component. - url(String) - Method in class io.micronaut.mcp.server.tools.fetch.FetchResponse.Builder
- url(String) - Method in class io.micronaut.mcp.server.tools.search.SearchResult.Builder
-
Set the url.
V
- validate(Map<String, Object>, Object) - Method in class io.micronaut.mcp.server.json.MicronautJsonSchemaValidator
- valueOf(String) - Static method in enum class io.micronaut.mcp.conf.Transport
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.micronaut.mcp.conf.Transport
-
Returns an array containing the constants of this enum class, in the order they are declared.
All Classes and Interfaces|All Packages|Constant Field Values