@breadstone/archipel-platform-mcp
Classes
| Class | Description |
|---|---|
| McpDiscoveryService | Discovers all NestJS providers that have methods decorated with @McpTool, @McpResource, or @McpPrompt and registers them in the McpRegistryService. |
| McpModule | NestJS dynamic module that bootstraps an MCP server. |
| McpRegistryService | Central registry that stores all MCP tool, resource, and prompt handlers discovered from NestJS providers. |
| McpServerService | Manages the MCP server lifecycle. Creates the McpServer instance, registers all discovered handlers from the registry, and provides methods to connect various transports. |
Interfaces
| Interface | Description |
|---|---|
| IMcpHandlerMetadata | Internal metadata stored for each decorated handler method. |
| IMcpModuleAsyncOptions | Async options for configuring the MCP module via a factory. |
| IMcpModuleOptions | Options for configuring the MCP module. |
| IMcpModuleOptionsFactory | Factory interface for creating MCP module options. |
| IMcpPromptMetadata | Metadata describing an MCP prompt registration. |
| IMcpResourceMetadata | Metadata describing an MCP resource registration. |
| IMcpToolMetadata | Metadata describing an MCP tool registration. |
| IRegisteredPrompt | Entry for a registered prompt handler. |
| IRegisteredResource | Entry for a registered resource handler. |
| IRegisteredTool | Entry for a registered tool handler. |
| ISseTransportOptions | Options for creating an SSE transport. |
| IStreamableHttpTransportOptions | Options for creating a Streamable HTTP transport. |
Variables
| Variable | Description |
|---|---|
| MCP_MODULE_OPTIONS | Injection tokens used by the MCP module. |
Functions
| Function | Description |
|---|---|
| McpPrompt | Marks a method as an MCP prompt handler. |
| McpResource | Marks a method as an MCP resource handler. |
| McpTool | Marks a method as an MCP tool handler. |