Index (Machai MCP Server 1.4.1 API)

A B E F G H L M O P R S T
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractHttpMcpServer - Class in org.machanism.machai.mcp.server: Abstract base class for HTTP-based MCP (Model Context Protocol) server implementations.
AbstractHttpMcpServer() - Constructor for class org.machanism.machai.mcp.server.AbstractHttpMcpServer: Constructs a new AbstractHttpMcpServer.
AbstractMcpServer - Class in org.machanism.machai.mcp.server: Base implementation of a Model Context Protocol (MCP) server.
AbstractMcpServer() - Constructor for class org.machanism.machai.mcp.server.AbstractMcpServer: Constructs a new AbstractMcpServer.
AbstractMcpServer.ToolSpecificationBuilder<E> - Interface in org.machanism.machai.mcp.server: Interface for building tool and tool specification objects for MCP servers.
AbstractPromptGenaiAdapter<E,S,P> - Class in org.machanism.machai.mcp.server: Common prompt-registration support for MCP GenAI adapters.
AbstractPromptGenaiAdapter(List<S>, AbstractMcpServer.ToolSpecificationBuilder<E>) - Constructor for class org.machanism.machai.mcp.server.AbstractPromptGenaiAdapter
AbstractPromptGenaiAdapter.PromptExecutionException - Exception Class in org.machanism.machai.mcp.server
addPrompt(String, String, ToolFunction, Role, ParamDescriptor...) - Method in class org.machanism.machai.mcp.server.AbstractPromptGenaiAdapter
addPromptMessage(List<McpSchema.PromptMessage>, String, Role) - Method in class org.machanism.machai.mcp.server.AbstractPromptGenaiAdapter
addPromptMessages(List<McpSchema.PromptMessage>, Object, ObjectMapper, Role) - Method in class org.machanism.machai.mcp.server.AbstractPromptGenaiAdapter
addPropDescription(Map<String, JsonValue>, List<String>, ParamDescriptor) - Method in class org.machanism.machai.mcp.server.GenericGenaiAdapter: Adds a property description to the tool schema.
addResource(URI, String, String, ToolFunction, ParamDescriptor...) - Method in class org.machanism.machai.mcp.server.HttpStatelessGenericGenaiAdapter
addSessionIdentifier(E, Map<String, Object>) - Method in class org.machanism.machai.mcp.server.AbstractPromptGenaiAdapter: Adds transport-specific session data to prompt arguments when available.
addSessionIdentifier(McpSyncServerExchange, Map<String, Object>) - Method in class org.machanism.machai.mcp.server.HttpStreamableGenericGenaiAdapter
addTool(String, String, ToolFunction, ParamDescriptor...) - Method in class org.machanism.machai.mcp.server.GenericGenaiAdapter: Register tool implementation for the adapter.
Architecture and operation - Search tag in Overview: Section

B

builder - Variable in class org.machanism.machai.mcp.server.GenericGenaiAdapter: Factory used to create transport-specific tool specifications.
buildPromptSpecification(McpSchema.Prompt, BiFunction<E, McpSchema.GetPromptRequest, McpSchema.GetPromptResult>) - Method in class org.machanism.machai.mcp.server.AbstractPromptGenaiAdapter
buildPromptSpecification(McpSchema.Prompt, BiFunction<McpTransportContext, McpSchema.GetPromptRequest, McpSchema.GetPromptResult>) - Method in class org.machanism.machai.mcp.server.HttpStatelessGenericGenaiAdapter
buildPromptSpecification(McpSchema.Prompt, BiFunction<McpSyncServerExchange, McpSchema.GetPromptRequest, McpSchema.GetPromptResult>) - Method in class org.machanism.machai.mcp.server.HttpStreamableGenericGenaiAdapter
buildPromptSpecification(McpSchema.Prompt, BiFunction<McpSyncServerExchange, McpSchema.GetPromptRequest, McpSchema.GetPromptResult>) - Method in class org.machanism.machai.mcp.server.StdioGenaiAdapter
buildSpecification(Object, BiFunction<E, McpSchema.CallToolRequest, McpSchema.CallToolResult>) - Method in interface org.machanism.machai.mcp.server.AbstractMcpServer.ToolSpecificationBuilder: Builds a tool specification object with the given tool and call handler.
buildSpecification(Object, BiFunction<McpTransportContext, McpSchema.CallToolRequest, McpSchema.CallToolResult>) - Method in class org.machanism.machai.mcp.server.HttpStatelessMcpServer.HttpStatelessToolSpecificationBuilder: Builds a SyncToolSpecification for the Remote MCP server.
buildSpecification(Object, BiFunction<McpSyncServerExchange, McpSchema.CallToolRequest, McpSchema.CallToolResult>) - Method in class org.machanism.machai.mcp.server.HttpStreamableMcpServer.HttpStreamableToolSpecificationBuilder: Builds a SyncToolSpecification for the Remote MCP server.
buildSpecification(Object, BiFunction<McpSyncServerExchange, McpSchema.CallToolRequest, McpSchema.CallToolResult>) - Method in class org.machanism.machai.mcp.server.StdioMcpServer.StdioToolSpecificationBuilder: Builds a SyncToolSpecification for the STDIO MCP server.

E

ENABLED_TOOLS_PARAM_NAME - Static variable in class org.machanism.machai.mcp.server.AbstractMcpServer
executePrompt(ToolFunction, JsonNode) - Method in class org.machanism.machai.mcp.server.AbstractPromptGenaiAdapter

F

formatSpecification(Object) - Static method in class org.machanism.machai.mcp.server.GenericGenaiAdapter
functionToolsLoader - Variable in class org.machanism.machai.mcp.server.HttpStatelessMcpServer: Loader for registering function-based tools.
functionToolsLoader - Variable in class org.machanism.machai.mcp.server.HttpStreamableMcpServer: Loader for registering function-based tools.
functionToolsLoader - Variable in class org.machanism.machai.mcp.server.StdioMcpServer: Loader for registering function-based tools.

G

GenericGenaiAdapter<E,S> - Class in org.machanism.machai.mcp.server: A generic adapter for integrating GenAI tools with different server implementations.
GenericGenaiAdapter(List<S>, AbstractMcpServer.ToolSpecificationBuilder<E>) - Constructor for class org.machanism.machai.mcp.server.GenericGenaiAdapter: Constructs a new GenericGenaiAdapter.
getConfigurator(String) - Static method in class org.machanism.machai.mcp.server.McpServer: Creates a configurator and loads the requested properties file.
getEnabledTools(Configurator) - Method in class org.machanism.machai.mcp.server.AbstractMcpServer: Reads the optional enabled-tool list from the server configuration.
getPort() - Method in class org.machanism.machai.mcp.server.AbstractHttpMcpServer: Returns the port number on which the server is configured to listen.
getProjectDir() - Method in class org.machanism.machai.mcp.server.AbstractMcpServer: Returns the configured project directory.
getPrompts() - Method in class org.machanism.machai.mcp.server.AbstractPromptGenaiAdapter: Returns the prompts registered with this adapter.
getResources() - Method in class org.machanism.machai.mcp.server.HttpStatelessGenericGenaiAdapter: Returns the resources registered with this adapter.
getTransportProvider() - Method in class org.machanism.machai.mcp.server.AbstractHttpMcpServer: Returns the HTTP servlet transport provider responsible for handling requests.

H

HttpStatelessGenericGenaiAdapter - Class in org.machanism.machai.mcp.server: Adapts Machai tools, prompts, and resources to the stateless HTTP MCP transport.
HttpStatelessGenericGenaiAdapter(List<McpStatelessServerFeatures.SyncToolSpecification>, AbstractMcpServer.ToolSpecificationBuilder<McpTransportContext>) - Constructor for class org.machanism.machai.mcp.server.HttpStatelessGenericGenaiAdapter: Creates an adapter backed by the supplied tool specification collection.
HttpStatelessMcpServer - Class in org.machanism.machai.mcp.server: HttpStatelessMcpServer sets up and runs a Model Context Protocol (MCP) server that listens for HTTP requests on a specified port.
HttpStatelessMcpServer(String, String) - Constructor for class org.machanism.machai.mcp.server.HttpStatelessMcpServer: Constructs a new HttpStatelessMcpServer with the given name and version.
HttpStatelessMcpServer.HttpStatelessToolSpecificationBuilder - Class in org.machanism.machai.mcp.server: Builds stateless MCP tool specifications from generic tool definitions.
HttpStatelessToolSpecificationBuilder() - Constructor for class org.machanism.machai.mcp.server.HttpStatelessMcpServer.HttpStatelessToolSpecificationBuilder
HttpStreamableGenericGenaiAdapter - Class in org.machanism.machai.mcp.server: Adapts Machai tools and prompts to the streamable HTTP MCP transport.
HttpStreamableGenericGenaiAdapter(List<McpServerFeatures.SyncToolSpecification>, AbstractMcpServer.ToolSpecificationBuilder<McpSyncServerExchange>) - Constructor for class org.machanism.machai.mcp.server.HttpStreamableGenericGenaiAdapter: Creates an adapter backed by the supplied tool specification collection.
HttpStreamableMcpServer - Class in org.machanism.machai.mcp.server: Configures and runs a streamable HTTP Model Context Protocol (MCP) server that listens for HTTP requests on a specified port.
HttpStreamableMcpServer(String, String) - Constructor for class org.machanism.machai.mcp.server.HttpStreamableMcpServer: Constructs a new streamable HTTP MCP server with the given name and version.
HttpStreamableMcpServer.HttpStreamableToolSpecificationBuilder - Class in org.machanism.machai.mcp.server: Builds streamable MCP tool specifications from generic tool definitions.
HttpStreamableToolSpecificationBuilder() - Constructor for class org.machanism.machai.mcp.server.HttpStreamableMcpServer.HttpStreamableToolSpecificationBuilder

L

log - Variable in class org.machanism.machai.mcp.server.AbstractHttpMcpServer: Logger instance for server events and diagnostics.
log - Variable in class org.machanism.machai.mcp.server.AbstractPromptGenaiAdapter
log - Variable in class org.machanism.machai.mcp.server.GenericGenaiAdapter: Logger used to report tool registration and invocation failures.
log - Variable in class org.machanism.machai.mcp.server.HttpStatelessMcpServer
log - Variable in class org.machanism.machai.mcp.server.HttpStreamableMcpServer
log - Static variable in class org.machanism.machai.mcp.server.McpServer

M

MACHAI_MACHANISM_HOMEPAGE - Static variable in class org.machanism.machai.mcp.server.AbstractMcpServer: The homepage URL for the Machai MCP server.
MACHAI_MACHANISM_ICON - Static variable in class org.machanism.machai.mcp.server.AbstractMcpServer: The icon URL for the Machai MCP server.
Machai MCP Server - Search tag in Overview: Section
main(String[]) - Static method in class org.machanism.machai.mcp.server.McpServer: Main entry point for the MCP server application.
MCP_CONFIG_FILE_NAME - Static variable in class org.machanism.machai.mcp.server.McpServer: Default Ghostwriter properties file name.
McpServer - Class in org.machanism.machai.mcp.server: Entry point for starting the MCP (Model Context Protocol) server.
McpServer() - Constructor for class org.machanism.machai.mcp.server.McpServer
McpServerStartupException - Exception Class in org.machanism.machai.mcp.server: Indicates that an MCP server could not be started.
McpServerStartupException(Exception) - Constructor for exception class org.machanism.machai.mcp.server.McpServerStartupException: Creates an exception with the startup failure as its cause.

O

org.machanism.machai.mcp.server - package org.machanism.machai.mcp.server: Provides Machai's synchronous Model Context Protocol (MCP) server runtime, command-line launcher, and transport adapters.

P

Packages - Search tag in Overview: Section
perform() - Method in class org.machanism.machai.mcp.server.GenericGenaiAdapter: This adapter registers callbacks rather than performing a standalone action.
port - Variable in class org.machanism.machai.mcp.server.AbstractHttpMcpServer: The port number on which the HTTP server will listen.
Principal types and relationships - Search tag in Overview: Section
projectDir - Variable in class org.machanism.machai.mcp.server.AbstractMcpServer
PromptExecutionException(Exception) - Constructor for exception class org.machanism.machai.mcp.server.AbstractPromptGenaiAdapter.PromptExecutionException
prompts - Variable in class org.machanism.machai.mcp.server.AbstractPromptGenaiAdapter

R

resourceSpecifications - Variable in class org.machanism.machai.mcp.server.HttpStatelessGenericGenaiAdapter: Resource specifications registered by this adapter.

S

serialVersionUID - Static variable in exception class org.machanism.machai.mcp.server.AbstractPromptGenaiAdapter.PromptExecutionException
serialVersionUID - Static variable in exception class org.machanism.machai.mcp.server.McpServerStartupException
server - Variable in class org.machanism.machai.mcp.server.HttpStatelessMcpServer: The MCP server specification for stateless sync operation.
server - Variable in class org.machanism.machai.mcp.server.HttpStreamableMcpServer: The MCP server specification for streamable synchronous operation.
server - Variable in class org.machanism.machai.mcp.server.StdioMcpServer: The MCP server specification for single-session sync operation.
Server transports - Search tag in package org.machanism.machai.mcp.server: Section
setPort(int) - Method in class org.machanism.machai.mcp.server.AbstractHttpMcpServer: Sets the port number for the server to listen on.
setProjectDir(File) - Method in class org.machanism.machai.mcp.server.AbstractMcpServer: Sets the project directory used by server tools.
setTransportProvider(HttpServlet) - Method in class org.machanism.machai.mcp.server.AbstractHttpMcpServer: Sets the HTTP servlet transport provider for handling requests.
start() - Method in class org.machanism.machai.mcp.server.AbstractMcpServer: Starts the MCP server.
start() - Method in class org.machanism.machai.mcp.server.HttpStatelessMcpServer: Starts the HTTP server and listens for incoming MCP requests on the specified port.
start() - Method in class org.machanism.machai.mcp.server.HttpStreamableMcpServer: Starts the HTTP server and listens for incoming MCP requests on the specified port.
start() - Method in class org.machanism.machai.mcp.server.StdioMcpServer: Builds and returns the configured McpSyncServer instance.
startHttpServer() - Method in class org.machanism.machai.mcp.server.AbstractHttpMcpServer: Starts the MCP HTTP server with the configured port and transport provider.
Starting a server - Search tag in package org.machanism.machai.mcp.server: Section
StdioGenaiAdapter - Class in org.machanism.machai.mcp.server: Adapts Machai tools and prompts to the synchronous STDIO MCP transport.
StdioGenaiAdapter(List<McpServerFeatures.SyncToolSpecification>, AbstractMcpServer.ToolSpecificationBuilder<McpSyncServerExchange>) - Constructor for class org.machanism.machai.mcp.server.StdioGenaiAdapter: Creates an adapter backed by the supplied tool specification collection.
StdioMcpServer - Class in org.machanism.machai.mcp.server: StdioMcpServer sets up and runs a Model Context Protocol (MCP) server that communicates via standard input and output (STDIO).
StdioMcpServer(String, String) - Constructor for class org.machanism.machai.mcp.server.StdioMcpServer: Constructs a new StdioMcpServer with the given name and version.
StdioMcpServer.StdioToolSpecificationBuilder - Class in org.machanism.machai.mcp.server
StdioToolSpecificationBuilder() - Constructor for class org.machanism.machai.mcp.server.StdioMcpServer.StdioToolSpecificationBuilder

T

toHumanReadable(String) - Static method in class org.machanism.machai.mcp.server.GenericGenaiAdapter: Converts a given tool name into a human-readable kebab-case format.
Tool and prompt adapters - Search tag in package org.machanism.machai.mcp.server: Section
tools(Configurator) - Method in class org.machanism.machai.mcp.server.AbstractMcpServer: Registers or defines the available tools for this MCP server.
tools(Configurator) - Method in class org.machanism.machai.mcp.server.HttpStatelessMcpServer: Loads and registers GenAI tools with the MCP server.
tools(Configurator) - Method in class org.machanism.machai.mcp.server.HttpStreamableMcpServer: Loads and registers GenAI tools with the MCP server.
tools(Configurator) - Method in class org.machanism.machai.mcp.server.StdioMcpServer: Loads and registers GenAI tools with the MCP server.
toolSpecifications - Variable in class org.machanism.machai.mcp.server.GenericGenaiAdapter: Collection receiving the transport-specific tool specifications.
transportProvider - Variable in class org.machanism.machai.mcp.server.AbstractHttpMcpServer: The HTTP servlet that acts as the transport provider for handling requests.
transportProvider - Variable in class org.machanism.machai.mcp.server.HttpStatelessMcpServer: HTTP transport provider for the MCP server.
transportProvider - Variable in class org.machanism.machai.mcp.server.HttpStreamableMcpServer: HTTP transport provider for the MCP server.

A B E F G H L M O P R S T
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form