@breadstone/archipel-mcp 0.0.14 → 0.0.16

package/data/packages/platform-mcp/api/Class.McpServerService.md

@@ -0,0 +1,196 @@
+---
+title: 'Class: McpServerService'
+generated: true
+editUrl: false
+---
+# Class: McpServerService
+
+Defined in: [services/McpServerService.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L39)
+
+Manages the MCP server lifecycle.
+Creates the `McpServer` instance, registers all discovered handlers from
+the registry, and provides methods to connect various transports.
+
+## Implements
+
+- `OnModuleInit`
+- `OnModuleDestroy`
+
+## Constructors
+
+### Constructor
+
+```ts
+new McpServerService(_options, _registry): McpServerService;
+```
+
+Defined in: [services/McpServerService.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L50)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `_options` | [`IMcpModuleOptions`](Interface.IMcpModuleOptions) |
+| `_registry` | [`McpRegistryService`](Class.McpRegistryService) |
+
+#### Returns
+
+`McpServerService`
+
+## Accessors
+
+### server
+
+#### Get Signature
+
+```ts
+get server(): McpServer;
+```
+
+Defined in: [services/McpServerService.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L64)
+
+Returns the underlying `McpServer` instance.
+
+##### Throws
+
+Error if the server has not been initialized yet.
+
+##### Returns
+
+`McpServer`
+
+## Methods
+
+### connectStdio()
+
+```ts
+connectStdio(): Promise<StdioServerTransport>;
+```
+
+Defined in: [services/McpServerService.ts:126](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L126)
+
+Connects the server to a stdio transport.
+Suitable for local, process-spawned integrations.
+
+#### Returns
+
+`Promise`\<`StdioServerTransport`\>
+
+***
+
+### connectTransport()
+
+```ts
+connectTransport(transport): Promise<void>;
+```
+
+Defined in: [services/McpServerService.ts:180](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L180)
+
+Connects a custom transport to the MCP server.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `transport` | `Transport` | Any transport implementing the MCP Transport interface. |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### createSseTransport()
+
+```ts
+createSseTransport(options, response): Promise<SSEServerTransport>;
+```
+
+Defined in: [services/McpServerService.ts:166](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L166)
+
+Creates an SSE transport for legacy client support.
+The caller is responsible for wiring the returned transport to Express routes.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | [`ISseTransportOptions`](Interface.ISseTransportOptions) | SSE transport configuration. |
+| `response` | `Response` | The Express response object for the SSE connection. |
+
+#### Returns
+
+`Promise`\<`SSEServerTransport`\>
+
+The configured SSE transport instance.
+
+***
+
+### createStreamableHttpTransport()
+
+```ts
+createStreamableHttpTransport(options?): Promise<StreamableHTTPServerTransport>;
+```
+
+Defined in: [services/McpServerService.ts:143](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L143)
+
+Creates a Streamable HTTP transport for use with Express.
+The caller is responsible for wiring the transport's `handleRequest`
+method to the appropriate Express routes.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options?` | [`IStreamableHttpTransportOptions`](Interface.IStreamableHttpTransportOptions) | Transport configuration options. |
+
+#### Returns
+
+`Promise`\<`StreamableHTTPServerTransport`\>
+
+The configured transport instance.
+
+***
+
+### onModuleDestroy()
+
+```ts
+onModuleDestroy(): Promise<void>;
+```
+
+Defined in: [services/McpServerService.ts:102](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L102)
+
+Cleans up all active transports when the module is destroyed.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+```ts
+OnModuleDestroy.onModuleDestroy
+```
+
+***
+
+### onModuleInit()
+
+```ts
+onModuleInit(): void;
+```
+
+Defined in: [services/McpServerService.ts:80](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L80)
+
+Initializes the MCP server and registers all tools, resources, and prompts
+from the registry.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+```ts
+OnModuleInit.onModuleInit
+```

package/data/packages/platform-mcp/api/Function.McpPrompt.md

@@ -0,0 +1,28 @@
+---
+title: 'Function: McpPrompt()'
+generated: true
+editUrl: false
+---
+# Function: McpPrompt()
+
+```ts
+function McpPrompt(options): MethodDecorator;
+```
+
+Defined in: [decorators/McpPrompt.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/decorators/McpPrompt.ts#L15)
+
+Marks a method as an MCP prompt handler.
+
+The decorated method will be discovered at module initialization and registered
+with the MCP server. The method receives the parsed prompt arguments and
+should return an `MCP GetPromptResult`.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | [`IMcpPromptMetadata`](Interface.IMcpPromptMetadata) | Prompt registration metadata. |
+
+## Returns
+
+`MethodDecorator`

package/data/packages/platform-mcp/api/Function.McpResource.md

@@ -0,0 +1,28 @@
+---
+title: 'Function: McpResource()'
+generated: true
+editUrl: false
+---
+# Function: McpResource()
+
+```ts
+function McpResource(options): MethodDecorator;
+```
+
+Defined in: [decorators/McpResource.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/decorators/McpResource.ts#L15)
+
+Marks a method as an MCP resource handler.
+
+The decorated method will be discovered at module initialization and registered
+with the MCP server. The method receives the URI and parsed template parameters
+as arguments and should return an `MCP ReadResourceResult`.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | [`IMcpResourceMetadata`](Interface.IMcpResourceMetadata) | Resource registration metadata. |
+
+## Returns
+
+`MethodDecorator`

package/data/packages/platform-mcp/api/Function.McpTool.md

@@ -0,0 +1,28 @@
+---
+title: 'Function: McpTool()'
+generated: true
+editUrl: false
+---
+# Function: McpTool()
+
+```ts
+function McpTool(options): MethodDecorator;
+```
+
+Defined in: [decorators/McpTool.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/decorators/McpTool.ts#L15)
+
+Marks a method as an MCP tool handler.
+
+The decorated method will be discovered at module initialization and registered
+with the MCP server. The method receives the parsed input as its first argument
+and should return an `MCP CallToolResult`.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | [`IMcpToolMetadata`](Interface.IMcpToolMetadata) | Tool registration metadata. |
+
+## Returns
+
+`MethodDecorator`

package/data/packages/platform-mcp/api/Interface.IMcpHandlerMetadata.md

@@ -0,0 +1,46 @@
+---
+title: 'Interface: IMcpHandlerMetadata'
+generated: true
+editUrl: false
+---
+# Interface: IMcpHandlerMetadata
+
+Defined in: [interfaces/IMcpHandlerMetadata.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpHandlerMetadata.ts#L4)
+
+Internal metadata stored for each decorated handler method.
+
+## Properties
+
+### metadata
+
+```ts
+readonly metadata: Record<string, unknown>;
+```
+
+Defined in: [interfaces/IMcpHandlerMetadata.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpHandlerMetadata.ts#L12)
+
+The metadata associated with the registration.
+
+***
+
+### methodName
+
+```ts
+readonly methodName: string;
+```
+
+Defined in: [interfaces/IMcpHandlerMetadata.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpHandlerMetadata.ts#L9)
+
+The method name on the provider class.
+
+***
+
+### type
+
+```ts
+readonly type: "tool" | "resource" | "prompt";
+```
+
+Defined in: [interfaces/IMcpHandlerMetadata.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpHandlerMetadata.ts#L6)
+
+Type of MCP capability.

package/data/packages/platform-mcp/api/Interface.IMcpModuleAsyncOptions.md

@@ -0,0 +1,75 @@
+---
+title: 'Interface: IMcpModuleAsyncOptions'
+generated: true
+editUrl: false
+---
+# Interface: IMcpModuleAsyncOptions
+
+Defined in: [interfaces/IMcpModuleOptions.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpModuleOptions.ts#L28)
+
+Async options for configuring the MCP module via a factory.
+
+## Extends
+
+- `Pick`\<`ModuleMetadata`, `"imports"`\>
+
+## Properties
+
+### inject?
+
+```ts
+readonly optional inject?: (InjectionToken | OptionalFactoryDependency)[];
+```
+
+Defined in: [interfaces/IMcpModuleOptions.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpModuleOptions.ts#L30)
+
+Injection tokens to make available to the factory.
+
+***
+
+### useClass?
+
+```ts
+readonly optional useClass?: Type<IMcpModuleOptionsFactory>;
+```
+
+Defined in: [interfaces/IMcpModuleOptions.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpModuleOptions.ts#L39)
+
+Optional class to instantiate as factory.
+
+***
+
+### useExisting?
+
+```ts
+readonly optional useExisting?: Type<IMcpModuleOptionsFactory>;
+```
+
+Defined in: [interfaces/IMcpModuleOptions.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpModuleOptions.ts#L36)
+
+Optional existing provider type.
+
+***
+
+### useFactory?
+
+```ts
+readonly optional useFactory?: (...args) => 
+  | IMcpModuleOptions
+| Promise<IMcpModuleOptions>;
+```
+
+Defined in: [interfaces/IMcpModuleOptions.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpModuleOptions.ts#L33)
+
+Factory function that returns module options (or a promise).
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| ...`args` | `unknown`[] |
+
+#### Returns
+
+  \| [`IMcpModuleOptions`](Interface.IMcpModuleOptions)
+  \| `Promise`\<[`IMcpModuleOptions`](Interface.IMcpModuleOptions)\>

package/data/packages/platform-mcp/api/Interface.IMcpModuleOptions.md

@@ -0,0 +1,125 @@
+---
+title: 'Interface: IMcpModuleOptions'
+generated: true
+editUrl: false
+---
+# Interface: IMcpModuleOptions
+
+Defined in: [interfaces/IMcpModuleOptions.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpModuleOptions.ts#L6)
+
+Options for configuring the MCP module.
+
+## Properties
+
+### capabilities?
+
+```ts
+readonly optional capabilities?: {
+  logging?: Record<string, unknown>;
+  prompts?: {
+     listChanged?: boolean;
+  };
+  resources?: {
+     listChanged?: boolean;
+     subscribe?: boolean;
+  };
+  tools?: {
+     listChanged?: boolean;
+  };
+};
+```
+
+Defined in: [interfaces/IMcpModuleOptions.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpModuleOptions.ts#L14)
+
+Optional server capabilities to advertise.
+
+#### logging?
+
+```ts
+readonly optional logging?: Record<string, unknown>;
+```
+
+#### prompts?
+
+```ts
+readonly optional prompts?: {
+  listChanged?: boolean;
+};
+```
+
+##### prompts.listChanged?
+
+```ts
+readonly optional listChanged?: boolean;
+```
+
+#### resources?
+
+```ts
+readonly optional resources?: {
+  listChanged?: boolean;
+  subscribe?: boolean;
+};
+```
+
+##### resources.listChanged?
+
+```ts
+readonly optional listChanged?: boolean;
+```
+
+##### resources.subscribe?
+
+```ts
+readonly optional subscribe?: boolean;
+```
+
+#### tools?
+
+```ts
+readonly optional tools?: {
+  listChanged?: boolean;
+};
+```
+
+##### tools.listChanged?
+
+```ts
+readonly optional listChanged?: boolean;
+```
+
+***
+
+### instructions?
+
+```ts
+readonly optional instructions?: string;
+```
+
+Defined in: [interfaces/IMcpModuleOptions.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpModuleOptions.ts#L22)
+
+Optional server instructions for clients.
+
+***
+
+### name
+
+```ts
+readonly name: string;
+```
+
+Defined in: [interfaces/IMcpModuleOptions.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpModuleOptions.ts#L8)
+
+Name of the MCP server (exposed to clients).
+
+***
+
+### version
+
+```ts
+readonly version: string;
+```
+
+Defined in: [interfaces/IMcpModuleOptions.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpModuleOptions.ts#L11)
+
+Version of the MCP server (exposed to clients).

package/data/packages/platform-mcp/api/Interface.IMcpModuleOptionsFactory.md

@@ -0,0 +1,27 @@
+---
+title: 'Interface: IMcpModuleOptionsFactory'
+generated: true
+editUrl: false
+---
+# Interface: IMcpModuleOptionsFactory
+
+Defined in: [interfaces/IMcpModuleOptions.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpModuleOptions.ts#L45)
+
+Factory interface for creating MCP module options.
+
+## Methods
+
+### createMcpOptions()
+
+```ts
+createMcpOptions(): 
+  | IMcpModuleOptions
+| Promise<IMcpModuleOptions>;
+```
+
+Defined in: [interfaces/IMcpModuleOptions.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpModuleOptions.ts#L46)
+
+#### Returns
+
+  \| [`IMcpModuleOptions`](Interface.IMcpModuleOptions)
+  \| `Promise`\<[`IMcpModuleOptions`](Interface.IMcpModuleOptions)\>

package/data/packages/platform-mcp/api/Interface.IMcpPromptMetadata.md

@@ -0,0 +1,58 @@
+---
+title: 'Interface: IMcpPromptMetadata'
+generated: true
+editUrl: false
+---
+# Interface: IMcpPromptMetadata
+
+Defined in: [interfaces/IMcpPromptMetadata.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpPromptMetadata.ts#L6)
+
+Metadata describing an MCP prompt registration.
+
+## Properties
+
+### argsSchema?
+
+```ts
+readonly optional argsSchema?: Record<string, ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>>;
+```
+
+Defined in: [interfaces/IMcpPromptMetadata.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpPromptMetadata.ts#L17)
+
+Zod schema defining the prompt's arguments.
+
+***
+
+### description?
+
+```ts
+readonly optional description?: string;
+```
+
+Defined in: [interfaces/IMcpPromptMetadata.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpPromptMetadata.ts#L14)
+
+Description of the prompt.
+
+***
+
+### name
+
+```ts
+readonly name: string;
+```
+
+Defined in: [interfaces/IMcpPromptMetadata.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpPromptMetadata.ts#L8)
+
+Unique name of the prompt.
+
+***
+
+### title?
+
+```ts
+readonly optional title?: string;
+```
+
+Defined in: [interfaces/IMcpPromptMetadata.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpPromptMetadata.ts#L11)
+
+Human-readable title of the prompt.

package/data/packages/platform-mcp/api/Interface.IMcpResourceMetadata.md

@@ -0,0 +1,72 @@
+---
+title: 'Interface: IMcpResourceMetadata'
+generated: true
+editUrl: false
+---
+# Interface: IMcpResourceMetadata
+
+Defined in: [interfaces/IMcpResourceMetadata.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpResourceMetadata.ts#L4)
+
+Metadata describing an MCP resource registration.
+
+## Properties
+
+### description?
+
+```ts
+readonly optional description?: string;
+```
+
+Defined in: [interfaces/IMcpResourceMetadata.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpResourceMetadata.ts#L19)
+
+Description of the resource.
+
+***
+
+### mimeType?
+
+```ts
+readonly optional mimeType?: string;
+```
+
+Defined in: [interfaces/IMcpResourceMetadata.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpResourceMetadata.ts#L22)
+
+MIME type of the resource content.
+
+***
+
+### name
+
+```ts
+readonly name: string;
+```
+
+Defined in: [interfaces/IMcpResourceMetadata.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpResourceMetadata.ts#L6)
+
+Unique name of the resource.
+
+***
+
+### title?
+
+```ts
+readonly optional title?: string;
+```
+
+Defined in: [interfaces/IMcpResourceMetadata.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpResourceMetadata.ts#L16)
+
+Human-readable title of the resource.
+
+***
+
+### uri
+
+```ts
+readonly uri: string;
+```
+
+Defined in: [interfaces/IMcpResourceMetadata.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpResourceMetadata.ts#L13)
+
+URI or URI template for the resource.
+Use a plain string for static resources, or a `ResourceTemplate` pattern
+(e.g. `users://{userId}/profile`) for dynamic resources.