Index
All Classes and Interfaces|All Packages
A
- allowedOrigins(String...) - Method in class dev.relism.flash.ext.mcp.McpConfig.Builder
-
Origins allowed to call the MCP endpoint (DNS-rebinding protection, per the Streamable HTTP transport spec).
- args() - Element in annotation interface dev.relism.flash.ext.mcp.Prompt
-
Arguments accepted by the prompt template — always strings per the MCP specification.
- args() - Element in annotation interface dev.relism.flash.ext.mcp.Tool
-
Input arguments — assembled into the tool's JSON Schema
inputSchemaonce at boot. - ARRAY - Enum constant in enum class dev.relism.flash.ext.mcp.ToolArgType
- ASSISTANT - Enum constant in enum class dev.relism.flash.ext.mcp.PromptMessage.Role
- authorizationServerIssuer(String) - Method in class dev.relism.flash.ext.mcp.McpConfig.Builder
-
Authorization server issuer URL, published in the RFC 9728 Protected Resource Metadata document at
/.well-known/oauth-protected-resource{rootPath}. - AUTO - Enum constant in enum class dev.relism.flash.ext.mcp.McpSecurity
-
Protect the endpoint if
flash-ext-oidcis installed; otherwise run unprotected and log a warning.
B
- bind(FlashContext) - Method in class dev.relism.flash.ext.mcp.McpPrompt
-
Called once by the framework after instantiation, before the first
prompts/get. - bind(FlashContext) - Method in class dev.relism.flash.ext.mcp.McpResource
-
Called once by the framework after instantiation, before the first
resources/read. - bind(FlashContext) - Method in class dev.relism.flash.ext.mcp.McpTool
-
Called once by the framework after instantiation, before the first
tools/call. - BOOLEAN - Enum constant in enum class dev.relism.flash.ext.mcp.ToolArgType
- build() - Method in class dev.relism.flash.ext.mcp.McpConfig.Builder
- builder(String) - Static method in class dev.relism.flash.ext.mcp.McpConfig
C
- call(ToolArguments) - Method in class dev.relism.flash.ext.mcp.McpTool
-
Invoked on every matching
tools/callrequest (hot path). - configure(FlashRegistrar<?>, FlashContext) - Method in class dev.relism.flash.ext.mcp.McpExtension
- content() - Method in record class dev.relism.flash.ext.mcp.PromptMessage
-
Returns the value of the
contentrecord component. - Content - Interface in dev.relism.flash.ext.mcp
-
MCP tool/prompt content block.
D
- description() - Element in annotation interface dev.relism.flash.ext.mcp.Prompt
- description() - Element in annotation interface dev.relism.flash.ext.mcp.PromptArg
- description() - Element in annotation interface dev.relism.flash.ext.mcp.Resource
- description() - Element in annotation interface dev.relism.flash.ext.mcp.Tool
-
Human/model-readable description of what the tool does.
- description() - Element in annotation interface dev.relism.flash.ext.mcp.ToolArg
- dev.relism.flash.ext.mcp - package dev.relism.flash.ext.mcp
E
- equals(Object) - Method in record class dev.relism.flash.ext.mcp.PromptMessage
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.relism.flash.ext.mcp.TextContent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.relism.flash.ext.mcp.TextResourceContents
-
Indicates whether some other object is "equal to" this one.
- error(String) - Static method in class dev.relism.flash.ext.mcp.ToolResponse
-
Tool-level failure — per the MCP specification this is still a normal JSON-RPC result (not a JSON-RPC error) with
isError: true, so the model can see and react to it.
F
- find(Class<T>) - Method in class dev.relism.flash.ext.mcp.McpPrompt
- find(Class<T>) - Method in class dev.relism.flash.ext.mcp.McpResource
- find(Class<T>) - Method in class dev.relism.flash.ext.mcp.McpTool
G
- getBoolean(String) - Method in class dev.relism.flash.ext.mcp.ToolArguments
- getBoolean(String, boolean) - Method in class dev.relism.flash.ext.mcp.ToolArguments
- getDouble(String) - Method in class dev.relism.flash.ext.mcp.ToolArguments
- getDouble(String, double) - Method in class dev.relism.flash.ext.mcp.ToolArguments
- getInt(String) - Method in class dev.relism.flash.ext.mcp.ToolArguments
- getInt(String, int) - Method in class dev.relism.flash.ext.mcp.ToolArguments
- getLong(String) - Method in class dev.relism.flash.ext.mcp.ToolArguments
- getLong(String, long) - Method in class dev.relism.flash.ext.mcp.ToolArguments
- getString(String) - Method in class dev.relism.flash.ext.mcp.PromptArguments
- getString(String) - Method in class dev.relism.flash.ext.mcp.ToolArguments
- getString(String, String) - Method in class dev.relism.flash.ext.mcp.PromptArguments
- getString(String, String) - Method in class dev.relism.flash.ext.mcp.ToolArguments
H
- has(String) - Method in class dev.relism.flash.ext.mcp.PromptArguments
- has(String) - Method in class dev.relism.flash.ext.mcp.ToolArguments
- hashCode() - Method in record class dev.relism.flash.ext.mcp.PromptMessage
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.relism.flash.ext.mcp.TextContent
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.relism.flash.ext.mcp.TextResourceContents
-
Returns a hash code value for this object.
I
- instructions(String) - Method in class dev.relism.flash.ext.mcp.McpConfig.Builder
-
Free-text instructions surfaced to the client at
initializetime. - INTEGER - Enum constant in enum class dev.relism.flash.ext.mcp.ToolArgType
M
- McpConfig - Class in dev.relism.flash.ext.mcp
-
Immutable configuration for
McpExtension. - McpConfig.Builder - Class in dev.relism.flash.ext.mcp
- McpExtension - Class in dev.relism.flash.ext.mcp
-
MCP (Model Context Protocol) server extension.
- McpExtension(McpConfig) - Constructor for class dev.relism.flash.ext.mcp.McpExtension
- McpPrompt - Class in dev.relism.flash.ext.mcp
-
Base class for a single MCP prompt template — one class per prompt, mirroring
McpTool. - McpPrompt() - Constructor for class dev.relism.flash.ext.mcp.McpPrompt
- McpResource - Class in dev.relism.flash.ext.mcp
-
Base class for a single MCP resource — one class per resource, mirroring
McpTool. - McpResource() - Constructor for class dev.relism.flash.ext.mcp.McpResource
- McpSecurity - Enum Class in dev.relism.flash.ext.mcp
-
OAuth2 requirement policy for the MCP endpoint, resolved against whether
flash-ext-oidcis installed (ctx.find(OidcMiddleware.class)). - McpTool - Class in dev.relism.flash.ext.mcp
-
Base class for a single MCP tool — one class per tool, mirroring
RequestHandler: declare metadata with@Tool, cache services inMcpTool.onInit(), implementMcpTool.call(ToolArguments)for the hot path. - McpTool() - Constructor for class dev.relism.flash.ext.mcp.McpTool
- mimeType() - Element in annotation interface dev.relism.flash.ext.mcp.Resource
- mimeType() - Method in record class dev.relism.flash.ext.mcp.TextResourceContents
-
Returns the value of the
mimeTyperecord component.
N
- name() - Element in annotation interface dev.relism.flash.ext.mcp.Prompt
-
Unique prompt name (used by clients in
prompts/get). - name() - Element in annotation interface dev.relism.flash.ext.mcp.PromptArg
- name() - Element in annotation interface dev.relism.flash.ext.mcp.Resource
- name() - Element in annotation interface dev.relism.flash.ext.mcp.Tool
-
Unique tool name (used by clients in
tools/call). - name() - Element in annotation interface dev.relism.flash.ext.mcp.ToolArg
- NONE - Enum constant in enum class dev.relism.flash.ext.mcp.McpSecurity
-
Never protect the endpoint, even if
flash-ext-oidcis installed elsewhere in the app. - NUMBER - Enum constant in enum class dev.relism.flash.ext.mcp.ToolArgType
O
- OBJECT - Enum constant in enum class dev.relism.flash.ext.mcp.ToolArgType
- of(String, String, String) - Static method in record class dev.relism.flash.ext.mcp.TextResourceContents
- onInit() - Method in class dev.relism.flash.ext.mcp.McpPrompt
- onInit() - Method in class dev.relism.flash.ext.mcp.McpResource
- onInit() - Method in class dev.relism.flash.ext.mcp.McpTool
-
Override to cache services at boot time.
- optional(Class<T>) - Method in class dev.relism.flash.ext.mcp.McpPrompt
- optional(Class<T>) - Method in class dev.relism.flash.ext.mcp.McpResource
- optional(Class<T>) - Method in class dev.relism.flash.ext.mcp.McpTool
P
- Prompt - Annotation Interface in dev.relism.flash.ext.mcp
-
Marks a
McpPromptsubclass as an MCP prompt template and declares its metadata, discovered by.invalid reference
McpConfig#toolsPackage(String) - PromptArg - Annotation Interface in dev.relism.flash.ext.mcp
-
Declares one argument of a
Prompt. - PromptArguments - Class in dev.relism.flash.ext.mcp
-
Typed accessor over a
prompts/getrequest'sargumentsobject. - PromptMessage - Record Class in dev.relism.flash.ext.mcp
-
A single message returned by a
McpPrompt. - PromptMessage(PromptMessage.Role, Content) - Constructor for record class dev.relism.flash.ext.mcp.PromptMessage
-
Creates an instance of a
PromptMessagerecord class. - PromptMessage.Role - Enum Class in dev.relism.flash.ext.mcp
R
- raw(String) - Method in class dev.relism.flash.ext.mcp.ToolArguments
-
Escape hatch for nested/array arguments not covered by the typed accessors above.
- read() - Method in class dev.relism.flash.ext.mcp.McpResource
-
Invoked on every matching
resources/readrequest (hot path). - render(PromptArguments) - Method in class dev.relism.flash.ext.mcp.McpPrompt
-
Invoked on every matching
prompts/getrequest (hot path). - require(Class<T>) - Method in class dev.relism.flash.ext.mcp.McpPrompt
- require(Class<T>) - Method in class dev.relism.flash.ext.mcp.McpResource
- require(Class<T>) - Method in class dev.relism.flash.ext.mcp.McpTool
- required() - Element in annotation interface dev.relism.flash.ext.mcp.PromptArg
- required() - Element in annotation interface dev.relism.flash.ext.mcp.ToolArg
- REQUIRED - Enum constant in enum class dev.relism.flash.ext.mcp.McpSecurity
-
Fail fast at boot if
flash-ext-oidcis not installed — never expose an unprotected MCP endpoint. - Resource - Annotation Interface in dev.relism.flash.ext.mcp
-
Marks a
McpResourcesubclass as an MCP resource and declares its metadata, discovered by.invalid reference
McpConfig#toolsPackage(String) - ResourceContents - Interface in dev.relism.flash.ext.mcp
-
MCP resource contents.
- resourceIdentifier(String) - Method in class dev.relism.flash.ext.mcp.McpConfig.Builder
-
Canonical URI of this MCP endpoint, used for RFC 8707 audience binding: tokens whose
audclaim does not include this value are rejected. - role() - Method in record class dev.relism.flash.ext.mcp.PromptMessage
-
Returns the value of the
rolerecord component. - rootPath(String) - Method in class dev.relism.flash.ext.mcp.McpConfig.Builder
-
HTTP path for the Streamable HTTP endpoint.
S
- scopesSupported(String...) - Method in class dev.relism.flash.ext.mcp.McpConfig.Builder
-
OAuth2 scopes this server expects clients to request, published as
scopes_supportedin the RFC 9728 Protected Resource Metadata document. - security(McpSecurity) - Method in class dev.relism.flash.ext.mcp.McpConfig.Builder
-
OAuth2 requirement policy.
- STRING - Enum constant in enum class dev.relism.flash.ext.mcp.ToolArgType
- success(Content...) - Static method in class dev.relism.flash.ext.mcp.ToolResponse
-
Successful tool result carrying one or more content blocks.
T
- text() - Method in record class dev.relism.flash.ext.mcp.TextContent
-
Returns the value of the
textrecord component. - text() - Method in record class dev.relism.flash.ext.mcp.TextResourceContents
-
Returns the value of the
textrecord component. - TextContent - Record Class in dev.relism.flash.ext.mcp
-
Plain-text content block (
type: "text"on the wire). - TextContent(String) - Constructor for record class dev.relism.flash.ext.mcp.TextContent
-
Creates an instance of a
TextContentrecord class. - TextResourceContents - Record Class in dev.relism.flash.ext.mcp
-
Text resource contents returned from
resources/read. - TextResourceContents(String, String, String) - Constructor for record class dev.relism.flash.ext.mcp.TextResourceContents
-
Creates an instance of a
TextResourceContentsrecord class. - title() - Element in annotation interface dev.relism.flash.ext.mcp.Tool
-
Optional display title, distinct from
Tool.name(). - Tool - Annotation Interface in dev.relism.flash.ext.mcp
-
Marks a
McpToolsubclass as an MCP tool and declares its metadata, discovered by.invalid reference
McpConfig#toolsPackage(String) - ToolArg - Annotation Interface in dev.relism.flash.ext.mcp
-
Declares one input argument of a
Tool. - ToolArgType - Enum Class in dev.relism.flash.ext.mcp
-
JSON Schema primitive types available for
ToolArg.type(). - ToolArguments - Class in dev.relism.flash.ext.mcp
-
Typed accessor over a
tools/callrequest'sargumentsobject. - ToolResponse - Class in dev.relism.flash.ext.mcp
-
Result of a
McpTool.call(ToolArguments)invocation. - toolsPackage(String) - Method in class dev.relism.flash.ext.mcp.McpConfig.Builder
- toString() - Method in record class dev.relism.flash.ext.mcp.PromptMessage
-
Returns a string representation of this record class.
- toString() - Method in record class dev.relism.flash.ext.mcp.TextContent
-
Returns a string representation of this record class.
- toString() - Method in record class dev.relism.flash.ext.mcp.TextResourceContents
-
Returns a string representation of this record class.
- type() - Element in annotation interface dev.relism.flash.ext.mcp.ToolArg
U
- uri() - Method in class dev.relism.flash.ext.mcp.McpResource
-
URI declared via
@Resource, cached at bind time. - uri() - Element in annotation interface dev.relism.flash.ext.mcp.Resource
-
Unique resource URI (used by clients in
resources/read). - uri() - Method in record class dev.relism.flash.ext.mcp.TextResourceContents
-
Returns the value of the
urirecord component. - USER - Enum constant in enum class dev.relism.flash.ext.mcp.PromptMessage.Role
V
- valueOf(String) - Static method in enum class dev.relism.flash.ext.mcp.McpSecurity
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class dev.relism.flash.ext.mcp.PromptMessage.Role
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class dev.relism.flash.ext.mcp.ToolArgType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class dev.relism.flash.ext.mcp.McpSecurity
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class dev.relism.flash.ext.mcp.PromptMessage.Role
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class dev.relism.flash.ext.mcp.ToolArgType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- version(String) - Method in class dev.relism.flash.ext.mcp.McpConfig.Builder
-
Server version reported in
initialize'sserverInfo.
W
- withAssistantRole(Content) - Static method in record class dev.relism.flash.ext.mcp.PromptMessage
- withUserRole(Content) - Static method in record class dev.relism.flash.ext.mcp.PromptMessage
All Classes and Interfaces|All Packages