@breadstone/archipel-mcp 0.0.1 → 0.0.3

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

@@ -0,0 +1,29 @@
+---
+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,29 @@
+---
+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,29 @@
+---
+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/Variable.MCP_MODULE_OPTIONS.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: MCP\_MODULE\_OPTIONS'
+generated: true
+editUrl: false
+---
+
+# Variable: MCP_MODULE_OPTIONS
+
+```ts
+const MCP_MODULE_OPTIONS: typeof MCP_MODULE_OPTIONS;
+```
+
+Defined in: [constants/McpTokens.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/constants/McpTokens.ts#L4)
+
+Injection tokens used by the MCP module.

package/data/packages/platform-mcp/api/index.md

@@ -34,90 +34,14 @@ editUrl: false
 
 ## Variables
 
-### MCP_MODULE_OPTIONS
-
-```ts
-const MCP_MODULE_OPTIONS: typeof MCP_MODULE_OPTIONS;
-```
-
-Defined in: [constants/McpTokens.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/constants/McpTokens.ts#L4)
-
-Injection tokens used by the MCP module.
+| Variable                                          | Description                              |
+| ------------------------------------------------- | ---------------------------------------- |
+| [MCP_MODULE_OPTIONS](Variable.MCP_MODULE_OPTIONS) | Injection tokens used by the MCP module. |
 
 ## Functions
 
-### 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`
-
----
-
-### 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`
-
----
-
-### 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`
+| Function                            | Description                                |
+| ----------------------------------- | ------------------------------------------ |
+| [McpPrompt](Function.McpPrompt)     | Marks a method as an MCP prompt handler.   |
+| [McpResource](Function.McpResource) | Marks a method as an MCP resource handler. |
+| [McpTool](Function.McpTool)         | Marks a method as an MCP tool handler.     |

package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
 
-[**@breadstone/archipel-platform-openapi**](../)
-
----
-
 # Class: SwaggerFeatureDiscovery
 
 Defined in: [discovery/SwaggerFeatureDiscovery.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/discovery/SwaggerFeatureDiscovery.ts#L13)

package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
 
-[**@breadstone/archipel-platform-openapi**](../)
-
----
-
 # Class: SwaggerFeatureRegistry
 
 Defined in: [registry/SwaggerFeatureRegistry.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/SwaggerFeatureRegistry.ts#L15)

package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
 
-[**@breadstone/archipel-platform-openapi**](../)
-
----
-
 # Class: SwaggerMultiDocumentService
 
 Defined in: [services/SwaggerMultiDocumentService.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/services/SwaggerMultiDocumentService.ts#L13)

package/data/packages/platform-openapi/api/Class.SwaggerTheme.md

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
 
-[**@breadstone/archipel-platform-openapi**](../)
-
----
-
 # Class: SwaggerTheme
 
 Defined in: [SwaggerTheme.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/SwaggerTheme.ts#L14)

package/data/packages/platform-openapi/api/Function.Api.md

@@ -0,0 +1,36 @@
+---
+title: 'Function: Api()'
+generated: true
+editUrl: false
+---
+
+# Function: Api()
+
+```ts
+function Api(options): ClassDecorator & MethodDecorator & PropertyDecorator;
+```
+
+Defined in: [decorators/Api.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/Api.ts#L21)
+
+Custom Swagger Decorator
+This decorator wraps all necessary Swagger decorators into one.
+
+## Parameters
+
+| Parameter             | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | Description                                                           |
+| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
+| `options`             | \{ `auth?`: `"bearer"` \| `"basic"` \| `"oauth2"` \| `"cookie"`; `body?`: `ApiBodyOptions`; `extensions?`: `Record`\<`string`, `string` \| `number` \| `boolean`\>; `headers?`: `ApiHeaderOptions`[]; `operation?`: `Partial`\<`OperationObject`\>; `params?`: `ApiParamOptions` \| `ApiParamOptions`[]; `query?`: `ApiQueryOptions` \| `ApiQueryOptions`[]; `responses?`: `ApiResponseOptions` \| `ApiResponseOptions`[]; `scopes?`: `string`[]; `tags?`: `string` \| `string`[]; \} | Configuration for the Swagger decorators.                             |
+| `options.auth?`       | `"bearer"` \| `"basic"` \| `"oauth2"` \| `"cookie"`                                                                                                                                                                                                                                                                                                                                                                                                                                   | -                                                                     |
+| `options.body?`       | `ApiBodyOptions`                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Options for the ApiBody decorator.                                    |
+| `options.extensions?` | `Record`\<`string`, `string` \| `number` \| `boolean`\>                                                                                                                                                                                                                                                                                                                                                                                                                               | -                                                                     |
+| `options.headers?`    | `ApiHeaderOptions`[]                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | Options for the ApiHeaders decorator.                                 |
+| `options.operation?`  | `Partial`\<`OperationObject`\>                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Options for the ApiOperation decorator.                               |
+| `options.params?`     | `ApiParamOptions` \| `ApiParamOptions`[]                                                                                                                                                                                                                                                                                                                                                                                                                                              | Options for the ApiParam decorator.                                   |
+| `options.query?`      | `ApiQueryOptions` \| `ApiQueryOptions`[]                                                                                                                                                                                                                                                                                                                                                                                                                                              | Options for the ApiQuery decorator (can be an array or single query). |
+| `options.responses?`  | `ApiResponseOptions` \| `ApiResponseOptions`[]                                                                                                                                                                                                                                                                                                                                                                                                                                        | -                                                                     |
+| `options.scopes?`     | `string`[]                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | -                                                                     |
+| `options.tags?`       | `string` \| `string`[]                                                                                                                                                                                                                                                                                                                                                                                                                                                                | Options for the ApiTags decorator (can be an array or single tag).    |
+
+## Returns
+
+`ClassDecorator` & `MethodDecorator` & `PropertyDecorator`

package/data/packages/platform-openapi/api/Function.SwaggerFeature.md

@@ -0,0 +1,43 @@
+---
+title: 'Function: SwaggerFeature()'
+generated: true
+editUrl: false
+---
+
+# Function: SwaggerFeature()
+
+```ts
+function SwaggerFeature(metadata): (target) => any;
+```
+
+Defined in: [decorators/SwaggerFeature.ts:94](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L94)
+
+Decorator to register a module as a Swagger feature.
+This allows the SwaggerMultiDocumentService to automatically discover and create documentation.
+
+## Parameters
+
+| Parameter  | Type                                                           | Description                                         |
+| ---------- | -------------------------------------------------------------- | --------------------------------------------------- |
+| `metadata` | [`ISwaggerFeatureMetadata`](Interface.ISwaggerFeatureMetadata) | The feature configuration for Swagger documentation |
+
+## Returns
+
+(`target`) => `any`
+
+## Example
+
+```typescript
+@SwaggerFeature({
+  name: 'tip',
+  title: 'Strivio API - Tips',
+  description: 'API endpoints for tip management',
+  tag: 'Tip',
+})
+@Module({
+  controllers: [TipController],
+  providers: [TipService],
+  exports: [TipService],
+})
+export class TipModule {}
+```

package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md

@@ -0,0 +1,19 @@
+---
+title: 'Function: getRegisteredSwaggerFeatures()'
+generated: true
+editUrl: false
+---
+
+# Function: getRegisteredSwaggerFeatures()
+
+```ts
+function getRegisteredSwaggerFeatures(): ISwaggerFeatureMetadata[];
+```
+
+Defined in: [decorators/SwaggerFeature.ts:122](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L122)
+
+Retrieves all Swagger features that have been registered through the decorator.
+
+## Returns
+
+[`ISwaggerFeatureMetadata`](Interface.ISwaggerFeatureMetadata)[]

package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md

@@ -0,0 +1,26 @@
+---
+title: 'Function: getSwaggerFeatureMetadata()'
+generated: true
+editUrl: false
+---
+
+# Function: getSwaggerFeatureMetadata()
+
+```ts
+function getSwaggerFeatureMetadata(target): ISwaggerFeatureMetadata | undefined;
+```
+
+Defined in: [decorators/SwaggerFeature.ts:115](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L115)
+
+Get the Swagger feature metadata from a module class
+
+## Parameters
+
+| Parameter | Type  |
+| --------- | ----- |
+| `target`  | `any` |
+
+## Returns
+
+\| [`ISwaggerFeatureMetadata`](Interface.ISwaggerFeatureMetadata)
+\| `undefined`

package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
 
-[**@breadstone/archipel-platform-openapi**](../)
-
----
-
 # Interface: IFeatureSwaggerConfig
 
 Defined in: [registry/IFeatureSwaggerConfig.ts:1](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L1)

package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
 
-[**@breadstone/archipel-platform-openapi**](../)
-
----
-
 # Interface: ISwaggerFeatureMetadata
 
 Defined in: [decorators/SwaggerFeature.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L18)

package/data/packages/platform-openapi/api/Variable.APP_VERSION.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: APP\_VERSION'
+generated: true
+editUrl: false
+---
+
+# Variable: APP_VERSION
+
+```ts
+const APP_VERSION: IConfigKey<string>;
+```
+
+Defined in: [env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/env.ts#L12)
+
+Application version shown in the Swagger document.

package/data/packages/platform-openapi/api/Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: PLATFORM\_OPENAPI\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+
+# Variable: PLATFORM_OPENAPI_CONFIG_ENTRIES
+
+```ts
+const PLATFORM_OPENAPI_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
+```
+
+Defined in: [env.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/env.ts#L28)
+
+All configuration entries required by `platform-openapi`.

package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_EMAIL.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: SWAGGER\_CONTACT\_EMAIL'
+generated: true
+editUrl: false
+---
+
+# Variable: SWAGGER_CONTACT_EMAIL
+
+```ts
+const SWAGGER_CONTACT_EMAIL: IConfigKey<string>;
+```
+
+Defined in: [env.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/env.ts#L21)
+
+Contact e-mail displayed in the Swagger document.

package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_NAME.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: SWAGGER\_CONTACT\_NAME'
+generated: true
+editUrl: false
+---
+
+# Variable: SWAGGER_CONTACT_NAME
+
+```ts
+const SWAGGER_CONTACT_NAME: IConfigKey<string>;
+```
+
+Defined in: [env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/env.ts#L15)
+
+Contact name displayed in the Swagger document.

package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_URL.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: SWAGGER\_CONTACT\_URL'
+generated: true
+editUrl: false
+---
+
+# Variable: SWAGGER_CONTACT_URL
+
+```ts
+const SWAGGER_CONTACT_URL: IConfigKey<string>;
+```
+
+Defined in: [env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/env.ts#L18)
+
+Contact URL displayed in the Swagger document.

package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md

@@ -0,0 +1,13 @@
+---
+title: 'Variable: SWAGGER\_FEATURE\_METADATA\_KEY'
+generated: true
+editUrl: false
+---
+
+# Variable: SWAGGER_FEATURE_METADATA_KEY
+
+```ts
+const SWAGGER_FEATURE_METADATA_KEY: 'swagger:feature' = 'swagger:feature';
+```
+
+Defined in: [decorators/SwaggerFeature.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L9)