[{"_1":2,"_332":-5,"_333":-5},"loaderData",{"_3":4,"_29":30,"_31":32,"_275":276},"root",{"_5":6,"_14":15},"toasts",[7],{"_8":9,"_10":11,"_12":13},"uid","01984433-67ce-7118-beeb-cd5449ae2f47","title","You need to sign in to access this page","type","error","visitor",{"_16":17,"_18":19},"viewportWidth",1280,"visitorSession",{"_20":21,"_23":24,"_25":-5,"_26":27,"_28":-5},"attributes",[22],"bot","id",9821443,"membership","referenceId","019843b4-2323-76ea-bef4-84db4bc95c8a","userAccount","routes/_public/_layout",{},"routes/_public/mcp/servers/~namespace/~slug/_pages/_layout",{"_33":34,"_89":-5,"_90":47,"_36":91,"_193":194,"_274":140},"availableLocales",[35,47,54,61,68,75,82],{"_36":37,"_40":44,"_45":46},"mcpServer",{"_38":39,"_40":41,"_42":43},"description","Ein NestJS-Modul, das die Bereitstellung von Diensten als MCP-Server mit Server-Sent Events-Transport ermöglicht und so die Tool-Erkennung und -Ausführung durch Clients erleichtert.","name","NestJS MCP-Servermodul","readme","# NestJS MCP-Servermodul\n\n[![CI](https://github.com/rekog-labs/MCP-Nest/actions/workflows/pipeline.yml/badge.svg)](https://github.com/rekog-labs/MCP-Nest/actions/workflows/pipeline.yml) [![Codeabdeckung](https://codecov.io/gh/rekog-labs/mcp-nest/branch/main/graph/badge.svg)](https://codecov.io/gh/rekog-labs/mcp-nest) [![NPM-Version](https://img.shields.io/npm/v/@rekog/mcp-nest)](https://www.npmjs.com/package/@rekog/mcp-nest) [![NPM-Downloads](https://img.shields.io/npm/dm/@rekog/mcp-nest)](https://www.npmjs.com/package/@rekog/mcp-nest) [![NPM-Lizenz](https://img.shields.io/npm/l/@rekog/mcp-nest)](https://www.npmjs.com/package/@rekog/mcp-nest)\n\nEin NestJS-Modul zum mühelosen Bereitstellen von Tools, Ressourcen und Eingabeaufforderungen für KI aus Ihren NestJS-Anwendungen mithilfe des **Model Context Protocol (MCP)** .\n\nMit `@rekog/mcp-nest` definieren Sie Tools, Ressourcen und Eingabeaufforderungen auf eine Weise, die in NestJS vertraut ist, und nutzen die volle Leistungsfähigkeit der Abhängigkeitsinjektion, um Ihre vorhandene Codebasis beim Erstellen komplexer, unternehmensreifer MCP-Server zu verwenden.\n\n## Merkmale\n\n* 🚀 Unterstützung für alle Transportarten:\n * Streambares HTTP\n * HTTP+SSE\n * STDIO\n* 🔍 Automatisches `tool` , `resource` und `prompt` Erkennung und Registrierung\n* 💯 Zod-basierte Tool-Aufrufvalidierung\n* 📊 Fortschrittsbenachrichtigungen\n* 🔒 Guard-basierte Authentifizierung\n* 🌐 Zugriff auf HTTP-Anforderungsinformationen innerhalb von MCP-Ressourcen (Tools, Ressourcen, Eingabeaufforderungen)\n\n## Installation\n\n```bash\nnpm install @rekog/mcp-nest @modelcontextprotocol/sdk zod\n```\n\n## Schnellstart\n\n### 1. Modul importieren\n\n```typescript\n// app.module.ts\nimport { Module } from '@nestjs/common';\nimport { McpModule } from '@rekog/mcp-nest';\nimport { GreetingTool } from './greeting.tool';\n\n@Module({\n imports: [\n McpModule.forRoot({\n name: 'my-mcp-server',\n version: '1.0.0',\n }),\n ],\n providers: [GreetingTool],\n})\nexport class AppModule {}\n```\n\n### 2. Definieren Sie Tools und Ressourcen\n\n```typescript\n// greeting.tool.ts\nimport type { Request } from 'express';\nimport { Injectable } from '@nestjs/common';\nimport { Tool, Resource, Context } from '@rekog/mcp-nest';\nimport { z } from 'zod';\nimport { Progress } from '@modelcontextprotocol/sdk/types';\n\n@Injectable()\nexport class GreetingTool {\n constructor() {}\n\n @Tool({\n name: 'hello-world',\n description:\n 'Returns a greeting and simulates a long operation with progress updates',\n parameters: z.object({\n name: z.string().default('World'),\n }),\n })\n async sayHello({ name }, context: Context, request: Request) {\n const userAgent = request.get('user-agent') || 'Unknown';\n const greeting = `Hello, ${name}! Your user agent is: ${userAgent}`;\n const totalSteps = 5;\n for (let i = 0; i < totalSteps; i++) {\n await new Promise((resolve) => setTimeout(resolve, 100));\n\n // Send a progress update.\n await context.reportProgress({\n progress: (i + 1) * 20,\n total: 100,\n } as Progress);\n }\n\n return {\n content: [{ type: 'text', text: greeting }],\n };\n }\n\n @Resource({\n uri: 'mcp://hello-world/{userName}',\n name: 'Hello World',\n description: 'A simple greeting resource',\n mimeType: 'text/plain',\n })\n // Different from the SDK, we put the parameters and URI in the same object.\n async getCurrentSchema({ uri, userName }) {\n return {\n content: [\n {\n uri,\n text: `User is ${userName}`,\n mimeType: 'text/plain',\n },\n ],\n };\n }\n}\n```\n\nSie sind fertig!\n\n> \\[!TIP] Das obige Beispiel zeigt, wie in MCP Tools auf HTTP- `Request` zugegriffen wird. Dies ist nützlich, um Benutzer zu identifizieren, clientspezifische Logik hinzuzufügen und viele andere Anwendungsfälle zu ermöglichen. Weitere Beispiele finden Sie in den [Authentifizierungstests](./tests/mcp-tool-auth.spec.ts) .\n\n## Schnellstart für STDIO\n\nDer Hauptunterschied besteht darin, dass Sie beim Importieren des Moduls die `transport` angeben müssen.\n\n```typescript\nMcpModule.forRoot({\n name: 'playground-stdio-server',\n version: '0.0.1',\n transport: McpTransportType.STDIO,\n});\n```\n\nDer Rest ist gleich. Sie können Tools, Ressourcen und Eingabeaufforderungen wie gewohnt definieren. Ein Beispiel für eine eigenständige NestJS-Anwendung mit STDIO-Transport ist das folgende:\n\n```typescript\nasync function bootstrap() {\n const app = await NestFactory.createApplicationContext(AppModule, {\n logger: false,\n });\n return app.close();\n}\n\nvoid bootstrap();\n```\n\nAls Nächstes können Sie den MCP-Server mit einem MCP-Stdio-Client verwenden ( [siehe Beispiel](playground/clients/stdio-client.ts) ) oder nach dem Erstellen Ihres Projekts mit der folgenden MCP-Client-Konfiguration:\n\n```json\n{\n \"mcpServers\": {\n \"greeting\": {\n \"command\": \"node\",\n \"args\": [\n \"\",\n ]\n }\n }\n}\n```\n\n## API-Endpunkte\n\nDer HTTP+SSE-Transport stellt zwei Endpunkte bereit:\n\n* `GET /sse` : SSE-Verbindungsendpunkt (durch Schutzvorrichtungen geschützt, falls konfiguriert)\n* `POST /messages` : Endpunkt der Tool-Ausführung (bei Konfiguration durch Schutzvorrichtungen geschützt)\n\nDer streambare HTTP-Transport stellt die folgenden Endpunkte bereit:\n\n* `POST /mcp` : Hauptendpunkt für alle MCP-Operationen (Toolausführung, Ressourcenzugriff usw.). Im Stateful-Modus werden Sitzungen erstellt und verwaltet.\n* `GET /mcp` : Erstellt Server-Sent Events (SSE)-Streams für Echtzeit-Updates und Fortschrittsbenachrichtigungen. **Nur im Stateful-Modus verfügbar.**\n* `DELETE /mcp` : Beendet MCP-Sitzungen. **Nur im Stateful-Modus verfügbar.**\n\n### Tipps\n\nEs ist möglich, das Modul mit einem globalen Präfix zu verwenden, es wird jedoch empfohlen, diese Endpunkte folgendermaßen auszuschließen:\n\n```typescript\napp.setGlobalPrefix('/api', { exclude: ['sse', 'messages', 'mcp'] });\n```\n\n## Authentifizierung\n\nSie können Ihre MCP-Endpunkte mit standardmäßigen NestJS Guards sichern.\n\n### 1. Erstellen Sie eine Wache\n\nImplementieren Sie die `CanActivate` Schnittstelle. Der Guard übernimmt die Anforderungsvalidierung (z. B. Überprüfung von JWTs und API-Schlüsseln) und fügt optional Benutzerinformationen an das Anforderungsobjekt an.\n\nNichts Besonderes, weitere Einzelheiten finden Sie in der NestJS-Dokumentation.\n\n### 2. Tragen Sie den Schutz auf\n\nÜbergeben Sie Ihre Schutzmaßnahmen an die `McpModule.forRoot` -Konfiguration. Die Schutzmaßnahmen werden sowohl auf die Endpunkte `/sse` als auch `/messages` angewendet.\n\n```typescript\n// app.module.ts\nimport { Module } from '@nestjs/common';\nimport { McpModule } from '@rekog/mcp-nest';\nimport { GreetingTool } from './greeting.tool';\nimport { AuthGuard } from './auth.guard';\n\n@Module({\n imports: [\n McpModule.forRoot({\n name: 'my-mcp-server',\n version: '1.0.0',\n guards: [AuthGuard], // Apply the guard here\n }),\n ],\n providers: [GreetingTool, AuthGuard], // Ensure the Guard is also provided\n})\nexport class AppModule {}\n```\n\nDas ist alles! Der Rest ist identisch mit NestJS Guards.\n\n## Spielplatz\n\nDas `playground` -Verzeichnis enthält Beispiele zum schnellen Testen von MCP- und `@rekog/mcp-nest` Funktionen. Weitere Informationen finden Sie in der [`playground/README.md`](playground/README.md) .\n\n## Konfiguration\n\nDie Methode `McpModule.forRoot()` akzeptiert ein `McpOptions` -Objekt zur Konfiguration des Servers. Folgende Optionen sind verfügbar:\n\n| Option | Beschreibung | Standard |\n| ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |\n| `name` | **Erforderlich.** Der Name Ihres MCP-Servers. | - |\n| `version` | **Erforderlich.** Die Version Ihres MCP-Servers. | - |\n| `capabilities` | Optionale MCP-Serverfunktionen zum Ankündigen. Siehe [@modelcontextprotocol/sdk](https://www.npmjs.com/package/@modelcontextprotocol/sdk) . | `undefined` |\n| `instructions` | Optionale Anweisungen für den Client zur Interaktion mit dem Server. | `undefined` |\n| `transport` | Gibt die zu aktivierenden Transporttypen an. | `[McpTransportType.SSE, McpTransportType.STREAMABLE_HTTP, McpTransportType.STDIO]` |\n| `sseEndpoint` | Der Endpunktpfad für die SSE-Verbindung (wird mit `SSE` Transport verwendet). | `'sse'` |\n| `messagesEndpoint` | Der Endpunktpfad zum Senden von Nachrichten (wird mit `SSE` Transport verwendet). | `'messages'` |\n| `mcpEndpoint` | Der Basisendpunktpfad für MCP-Operationen (wird mit `STREAMABLE_HTTP` -Transport verwendet). | `'mcp'` |\n| `globalApiPrefix` | Ein globales Präfix für alle MCP-Endpunkte. Nützlich bei der Integration in eine vorhandene Anwendung. | `''` |\n| `guards` | Ein Array von NestJS Guards, die zur Authentifizierung/Autorisierung auf die MCP-Endpunkte angewendet werden. | `[]` |\n| `decorators` | Ein Array von NestJS-Klassendekoratoren, die auf die generierten MCP-Controller angewendet werden sollen. | `[]` |\n| `sse` | Konfiguration spezifisch für den `SSE` -Transport. | `{ pingEnabled: true, pingIntervalMs: 30000 }` |\n| `sse.pingEnabled` | Ob regelmäßige SSE-Ping-Nachrichten aktiviert werden sollen, um die Verbindung aufrechtzuerhalten. | `true` |\n| `sse.pingIntervalMs` | Das Intervall (in Millisekunden) zum Senden von SSE-Ping-Nachrichten. | `30000` |\n| `streamableHttp` | Konfiguration spezifisch für den `STREAMABLE_HTTP` Transport. | `{ enableJsonResponse: true, sessionIdGenerator: undefined, statelessMode: true }` |\n| `streamableHttp.enableJsonResponse` | Wenn `true` , kann der `/mcp` -Endpunkt JSON-Antworten für Nicht-Streaming-Anfragen (wie `listTools` ) zurückgeben. | `true` |\n| `streamableHttp.sessionIdGenerator` | Eine Funktion zum Generieren eindeutiger Sitzungs-IDs im Stateful-Modus. Erforderlich, wenn `statelessMode` `false` ist. | `undefined` |\n| `streamableHttp.statelessMode` | Bei `true` erfolgt der `STREAMABLE_HTTP` -Transport zustandslos (keine Sitzungen). Bei `false` erfolgt der Transport zustandsbehaftet und erfordert einen `sessionIdGenerator` . | `true` |","German","tag","de-DE",{"_36":48,"_40":52,"_45":53},{"_38":49,"_40":50,"_42":51},"A NestJS module that allows services to be exposed as an MCP server with Server-Sent Events transport, facilitating tool discovery and execution by clients.","NestJS MCP Server Module","# NestJS MCP Server Module\n\n

\n\n[![CI][ci-image]][ci-url]\n[![Code Coverage][code-coverage-image]][code-coverage-url]\n[![NPM Version][npm-version-image]][npm-url]\n[![NPM Downloads][npm-downloads-image]][npm-url]\n[![NPM License][npm-license-image]][npm-url]\n\n

\n\nA NestJS module to effortlessly expose tools, resources, and prompts for AI, from your NestJS applications using the **Model Context Protocol (MCP)**.\n\nWith `@rekog/mcp-nest` you define tools, resources, and prompts in a way that's familiar in NestJS and leverage the full power of dependency injection to utilize your existing codebase in building complex enterprise ready MCP servers.\n\n## Features\n\n- 🚀 Support for all Transport Types:\n - Streamable HTTP\n - HTTP+SSE\n - STDIO\n- 🔍 Automatic `tool`, `resource`, and `prompt` discovery and registration\n- 💯 Zod-based tool call validation\n- 📊 Progress notifications\n- 🔒 Guard-based authentication\n- 🌐 Access to HTTP Request information within MCP Resources (Tools, Resources, Prompts)\n\n## Installation\n\n```bash\nnpm install @rekog/mcp-nest @modelcontextprotocol/sdk zod\n```\n\n## Quick Start\n\n### 1. Import Module\n\n```typescript\n// app.module.ts\nimport { Module } from '@nestjs/common';\nimport { McpModule } from '@rekog/mcp-nest';\nimport { GreetingTool } from './greeting.tool';\n\n@Module({\n imports: [\n McpModule.forRoot({\n name: 'my-mcp-server',\n version: '1.0.0',\n }),\n ],\n providers: [GreetingTool],\n})\nexport class AppModule {}\n```\n\n### 2. Define Tools and Resource\n\n```typescript\n// greeting.tool.ts\nimport type { Request } from 'express';\nimport { Injectable } from '@nestjs/common';\nimport { Tool, Resource, Context } from '@rekog/mcp-nest';\nimport { z } from 'zod';\nimport { Progress } from '@modelcontextprotocol/sdk/types';\n\n@Injectable()\nexport class GreetingTool {\n constructor() {}\n\n @Tool({\n name: 'hello-world',\n description:\n 'Returns a greeting and simulates a long operation with progress updates',\n parameters: z.object({\n name: z.string().default('World'),\n }),\n })\n async sayHello({ name }, context: Context, request: Request) {\n const userAgent = request.get('user-agent') || 'Unknown';\n const greeting = `Hello, ${name}! Your user agent is: ${userAgent}`;\n const totalSteps = 5;\n for (let i = 0; i < totalSteps; i++) {\n await new Promise((resolve) => setTimeout(resolve, 100));\n\n // Send a progress update.\n await context.reportProgress({\n progress: (i + 1) * 20,\n total: 100,\n } as Progress);\n }\n\n return {\n content: [{ type: 'text', text: greeting }],\n };\n }\n\n @Resource({\n uri: 'mcp://hello-world/{userName}',\n name: 'Hello World',\n description: 'A simple greeting resource',\n mimeType: 'text/plain',\n })\n // Different from the SDK, we put the parameters and URI in the same object.\n async getCurrentSchema({ uri, userName }) {\n return {\n content: [\n {\n uri,\n text: `User is ${userName}`,\n mimeType: 'text/plain',\n },\n ],\n };\n }\n}\n```\n\nYou are done!\n\n> [!TIP]\n> The above example shows how HTTP `Request` headers are accessed within MCP Tools. This is useful for identifying users, adding client-specific logic, and many other use cases. For more examples, see the [Authentication Tests](./tests/mcp-tool-auth.spec.ts).\n\n## Quick Start for STDIO\n\nThe main difference is that you need to provide the `transport` option when importing the module.\n\n```typescript\nMcpModule.forRoot({\n name: 'playground-stdio-server',\n version: '0.0.1',\n transport: McpTransportType.STDIO,\n});\n```\n\nThe rest is the same, you can define tools, resources, and prompts as usual. An example of a standalone NestJS application using the STDIO transport is the following:\n\n```typescript\nasync function bootstrap() {\n const app = await NestFactory.createApplicationContext(AppModule, {\n logger: false,\n });\n return app.close();\n}\n\nvoid bootstrap();\n```\n\nNext, you can use the MCP server with an MCP Stdio Client ([see example](playground/clients/stdio-client.ts)), or after building your project you can use it with the following MCP Client configuration:\n\n```json\n{\n \"mcpServers\": {\n \"greeting\": {\n \"command\": \"node\",\n \"args\": [\n \"\",\n ]\n }\n }\n}\n```\n\n## API Endpoints\n\nHTTP+SSE transport exposes two endpoints:\n\n- `GET /sse`: SSE connection endpoint (Protected by guards if configured)\n- `POST /messages`: Tool execution endpoint (Protected by guards if configured)\n\nStreamable HTTP transport exposes the following endpoints:\n\n- `POST /mcp`: Main endpoint for all MCP operations (tool execution, resource access, etc.). In stateful mode, this creates and maintains sessions.\n- `GET /mcp`: Establishes Server-Sent Events (SSE) streams for real-time updates and progress notifications. **Only available in stateful mode.**\n- `DELETE /mcp`: Terminates MCP sessions. **Only available in stateful mode.**\n\n### Tips\n\nIt's possible to use the module with global prefix, but the recommended way is to exclude those endpoints with:\n\n```typescript\napp.setGlobalPrefix('/api', { exclude: ['sse', 'messages', 'mcp'] });\n```\n\n## Authentication\n\nYou can secure your MCP endpoints using standard NestJS Guards.\n\n### 1. Create a Guard\n\nImplement the `CanActivate` interface. The guard should handle request validation (e.g., checking JWTs, API keys) and optionally attach user information to the request object.\n\nNothing special, check the NestJS documentation for more details.\n\n### 2. Apply the Guard\n\nPass your guard(s) to the `McpModule.forRoot` configuration. The guard(s) will be applied to both the `/sse` and `/messages` endpoints.\n\n```typescript\n// app.module.ts\nimport { Module } from '@nestjs/common';\nimport { McpModule } from '@rekog/mcp-nest';\nimport { GreetingTool } from './greeting.tool';\nimport { AuthGuard } from './auth.guard';\n\n@Module({\n imports: [\n McpModule.forRoot({\n name: 'my-mcp-server',\n version: '1.0.0',\n guards: [AuthGuard], // Apply the guard here\n }),\n ],\n providers: [GreetingTool, AuthGuard], // Ensure the Guard is also provided\n})\nexport class AppModule {}\n```\n\nThat's it! The rest is the same as NestJS Guards.\n\n## Playground\n\nThe `playground` directory contains examples to quickly test MCP and `@rekog/mcp-nest` features.\nRefer to the [`playground/README.md`](playground/README.md) for more details.\n\n## Configuration\n\nThe `McpModule.forRoot()` method accepts an `McpOptions` object to configure the server. Here are the available options:\n\n| Option | Description | Default |\n| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |\n| `name` | **Required.** The name of your MCP server. | - |\n| `version` | **Required.** The version of your MCP server. | - |\n| `capabilities` | Optional MCP server capabilities to advertise. See [@modelcontextprotocol/sdk](https://www.npmjs.com/package/@modelcontextprotocol/sdk). | `undefined` |\n| `instructions` | Optional instructions for the client on how to interact with the server. | `undefined` |\n| `transport` | Specifies the transport type(s) to enable. | `[McpTransportType.SSE, McpTransportType.STREAMABLE_HTTP, McpTransportType.STDIO]` |\n| `sseEndpoint` | The endpoint path for the SSE connection (used with `SSE` transport). | `'sse'` |\n| `messagesEndpoint` | The endpoint path for sending messages (used with `SSE` transport). | `'messages'` |\n| `mcpEndpoint` | The base endpoint path for MCP operations (used with `STREAMABLE_HTTP` transport). | `'mcp'` |\n| `globalApiPrefix` | A global prefix for all MCP endpoints. Useful if integrating into an existing application. | `''` |\n| `guards` | An array of NestJS Guards to apply to the MCP endpoints for authentication/authorization. | `[]` |\n| `decorators` | An array of NestJS Class Decorators to apply to the generated MCP controllers. | `[]` |\n| `sse` | Configuration specific to the `SSE` transport. | `{ pingEnabled: true, pingIntervalMs: 30000 }` |\n| `sse.pingEnabled` | Whether to enable periodic SSE ping messages to keep the connection alive. | `true` |\n| `sse.pingIntervalMs` | The interval (in milliseconds) for sending SSE ping messages. | `30000` |\n| `streamableHttp` | Configuration specific to the `STREAMABLE_HTTP` transport. | `{ enableJsonResponse: true, sessionIdGenerator: undefined, statelessMode: true }` |\n| `streamableHttp.enableJsonResponse` | If `true`, allows the `/mcp` endpoint to return JSON responses for non-streaming requests (like `listTools`). | `true` |\n| `streamableHttp.sessionIdGenerator` | A function to generate unique session IDs when running in stateful mode. Required if `statelessMode` is `false`. | `undefined` |\n| `streamableHttp.statelessMode` | If `true`, the `STREAMABLE_HTTP` transport operates statelessly (no sessions). If `false`, it operates statefully, requiring a `sessionIdGenerator`. | `true` |\n\n\n[ci-url]: https://github.com/rekog-labs/MCP-Nest/actions/workflows/pipeline.yml\n[ci-image]: https://github.com/rekog-labs/MCP-Nest/actions/workflows/pipeline.yml/badge.svg\n[npm-url]: https://www.npmjs.com/package/@rekog/mcp-nest\n[npm-version-image]: https://img.shields.io/npm/v/@rekog/mcp-nest\n[npm-downloads-image]: https://img.shields.io/npm/dm/@rekog/mcp-nest\n[npm-license-image]: https://img.shields.io/npm/l/@rekog/mcp-nest\n[code-coverage-url]: https://codecov.io/gh/rekog-labs/mcp-nest\n[code-coverage-image]: https://codecov.io/gh/rekog-labs/mcp-nest/branch/main/graph/badge.svg\n","English","en-US",{"_36":55,"_40":59,"_45":60},{"_38":56,"_40":57,"_42":58},"Un módulo NestJS que permite exponer los servicios como un servidor MCP con transporte de eventos enviados por el servidor, lo que facilita el descubrimiento y la ejecución de herramientas por parte de los clientes.","Módulo de servidor MCP de NestJS","# Módulo de servidor MCP de NestJS\n\n[![CI](https://github.com/rekog-labs/MCP-Nest/actions/workflows/pipeline.yml/badge.svg)](https://github.com/rekog-labs/MCP-Nest/actions/workflows/pipeline.yml) [![Cobertura del código](https://codecov.io/gh/rekog-labs/mcp-nest/branch/main/graph/badge.svg)](https://codecov.io/gh/rekog-labs/mcp-nest) [![Versión NPM](https://img.shields.io/npm/v/@rekog/mcp-nest)](https://www.npmjs.com/package/@rekog/mcp-nest) [![Descargas de NPM](https://img.shields.io/npm/dm/@rekog/mcp-nest)](https://www.npmjs.com/package/@rekog/mcp-nest) [![Licencia NPM](https://img.shields.io/npm/l/@rekog/mcp-nest)](https://www.npmjs.com/package/@rekog/mcp-nest)\n\nUn módulo NestJS para exponer sin esfuerzo herramientas, recursos y avisos para IA, desde sus aplicaciones NestJS utilizando el **Protocolo de contexto de modelo (MCP)** .\n\nCon `@rekog/mcp-nest` define herramientas, recursos y avisos de una manera familiar en NestJS y aprovecha todo el poder de la inyección de dependencia para utilizar tu base de código existente en la creación de servidores MCP complejos y listos para la empresa.\n\n## Características\n\n* 🚀 Soporte para todos los tipos de transporte:\n * HTTP transmisible\n * HTTP+SSE\n * STDIO\n* 🔍 `tool` automática, `resource` y descubrimiento y registro `prompt`\n* Validación de llamadas a herramientas basadas en Zod\n* 📊 Notificaciones de progreso\n* Autenticación basada en guardia\n* 🌐 Acceso a la información de solicitudes HTTP dentro de los recursos de MCP (herramientas, recursos, indicaciones)\n\n## Instalación\n\n```bash\nnpm install @rekog/mcp-nest @modelcontextprotocol/sdk zod\n```\n\n## Inicio rápido\n\n### 1. Módulo de importación\n\n```typescript\n// app.module.ts\nimport { Module } from '@nestjs/common';\nimport { McpModule } from '@rekog/mcp-nest';\nimport { GreetingTool } from './greeting.tool';\n\n@Module({\n imports: [\n McpModule.forRoot({\n name: 'my-mcp-server',\n version: '1.0.0',\n }),\n ],\n providers: [GreetingTool],\n})\nexport class AppModule {}\n```\n\n### 2. Definir herramientas y recursos\n\n```typescript\n// greeting.tool.ts\nimport type { Request } from 'express';\nimport { Injectable } from '@nestjs/common';\nimport { Tool, Resource, Context } from '@rekog/mcp-nest';\nimport { z } from 'zod';\nimport { Progress } from '@modelcontextprotocol/sdk/types';\n\n@Injectable()\nexport class GreetingTool {\n constructor() {}\n\n @Tool({\n name: 'hello-world',\n description:\n 'Returns a greeting and simulates a long operation with progress updates',\n parameters: z.object({\n name: z.string().default('World'),\n }),\n })\n async sayHello({ name }, context: Context, request: Request) {\n const userAgent = request.get('user-agent') || 'Unknown';\n const greeting = `Hello, ${name}! Your user agent is: ${userAgent}`;\n const totalSteps = 5;\n for (let i = 0; i < totalSteps; i++) {\n await new Promise((resolve) => setTimeout(resolve, 100));\n\n // Send a progress update.\n await context.reportProgress({\n progress: (i + 1) * 20,\n total: 100,\n } as Progress);\n }\n\n return {\n content: [{ type: 'text', text: greeting }],\n };\n }\n\n @Resource({\n uri: 'mcp://hello-world/{userName}',\n name: 'Hello World',\n description: 'A simple greeting resource',\n mimeType: 'text/plain',\n })\n // Different from the SDK, we put the parameters and URI in the same object.\n async getCurrentSchema({ uri, userName }) {\n return {\n content: [\n {\n uri,\n text: `User is ${userName}`,\n mimeType: 'text/plain',\n },\n ],\n };\n }\n}\n```\n\n¡Ya estás listo!\n\n> \\[!TIP] El ejemplo anterior muestra cómo se accede a los encabezados `Request` HTTP en MCP Tools. Esto resulta útil para identificar usuarios, agregar lógica específica del cliente y muchos otros casos de uso. Para más ejemplos, consulte las [Pruebas de autenticación](./tests/mcp-tool-auth.spec.ts) .\n\n## Inicio rápido para STDIO\n\nLa principal diferencia es que debes proporcionar la opción `transport` al importar el módulo.\n\n```typescript\nMcpModule.forRoot({\n name: 'playground-stdio-server',\n version: '0.0.1',\n transport: McpTransportType.STDIO,\n});\n```\n\nEl resto es igual: puedes definir herramientas, recursos y avisos como siempre. A continuación, se muestra un ejemplo de una aplicación NestJS independiente que utiliza el transporte STDIO:\n\n```typescript\nasync function bootstrap() {\n const app = await NestFactory.createApplicationContext(AppModule, {\n logger: false,\n });\n return app.close();\n}\n\nvoid bootstrap();\n```\n\nA continuación, puede utilizar el servidor MCP con un cliente MCP Stdio ( [ver ejemplo](playground/clients/stdio-client.ts) ) o, después de crear su proyecto, puede usarlo con la siguiente configuración de cliente MCP:\n\n```json\n{\n \"mcpServers\": {\n \"greeting\": {\n \"command\": \"node\",\n \"args\": [\n \"\",\n ]\n }\n }\n}\n```\n\n## Puntos finales de API\n\nEl transporte HTTP+SSE expone dos puntos finales:\n\n* `GET /sse` : punto final de conexión SSE (protegido por protectores si está configurado)\n* `POST /messages` : Punto final de ejecución de la herramienta (protegido por guardias si está configurado)\n\nEl transporte HTTP transmisible expone los siguientes puntos finales:\n\n* `POST /mcp` : Punto final principal para todas las operaciones de MCP (ejecución de herramientas, acceso a recursos, etc.). En modo con estado, crea y mantiene sesiones.\n* `GET /mcp` : Establece flujos de eventos enviados por el servidor (SSE) para actualizaciones en tiempo real y notificaciones de progreso. **Solo disponible en modo con estado.**\n* `DELETE /mcp` : Finaliza las sesiones MCP. **Solo disponible en modo con estado.**\n\n### Consejos\n\nEs posible utilizar el módulo con prefijo global, pero la forma recomendada es excluir esos puntos finales con:\n\n```typescript\napp.setGlobalPrefix('/api', { exclude: ['sse', 'messages', 'mcp'] });\n```\n\n## Autenticación\n\nPuede proteger sus puntos finales de MCP utilizando NestJS Guards estándar.\n\n### 1. Crea un guardia\n\nImplementar la interfaz `CanActivate` . El guardián debe gestionar la validación de solicitudes (p. ej., comprobar JWT y claves API) y, opcionalmente, adjuntar información del usuario al objeto de solicitud.\n\nNada especial, consulte la documentación de NestJS para obtener más detalles.\n\n### 2. Aplicar la protección\n\nTransfiera sus protecciones a la configuración de `McpModule.forRoot` . Estas se aplicarán a los puntos finales `/sse` y `/messages` .\n\n```typescript\n// app.module.ts\nimport { Module } from '@nestjs/common';\nimport { McpModule } from '@rekog/mcp-nest';\nimport { GreetingTool } from './greeting.tool';\nimport { AuthGuard } from './auth.guard';\n\n@Module({\n imports: [\n McpModule.forRoot({\n name: 'my-mcp-server',\n version: '1.0.0',\n guards: [AuthGuard], // Apply the guard here\n }),\n ],\n providers: [GreetingTool, AuthGuard], // Ensure the Guard is also provided\n})\nexport class AppModule {}\n```\n\n¡Listo! El resto es igual que con NestJS Guards.\n\n## Patio de juegos\n\nEl directorio `playground` contiene ejemplos para probar rápidamente las funciones de MCP y `@rekog/mcp-nest` . Consulte el [`playground/README.md`](playground/README.md) para obtener más información.\n\n## Configuración\n\nEl método `McpModule.forRoot()` acepta un objeto `McpOptions` para configurar el servidor. Estas son las opciones disponibles:\n\n| Opción | Descripción | Por defecto |\n| ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |\n| `name` | **Obligatorio.** El nombre de su servidor MCP. | - |\n| `version` | **Obligatorio.** La versión de su servidor MCP. | - |\n| `capabilities` | Funciones opcionales del servidor MCP para publicidad. Consulte [@modelcontextprotocol/sdk](https://www.npmjs.com/package/@modelcontextprotocol/sdk) . | `undefined` |\n| `instructions` | Instrucciones opcionales para el cliente sobre cómo interactuar con el servidor. | `undefined` |\n| `transport` | Especifica el tipo(s) de transporte a habilitar. | `[McpTransportType.SSE, McpTransportType.STREAMABLE_HTTP, McpTransportType.STDIO]` |\n| `sseEndpoint` | La ruta del punto final para la conexión SSE (utilizada con el transporte `SSE` ). | `'sse'` |\n| `messagesEndpoint` | La ruta del punto final para enviar mensajes (utilizada con el transporte `SSE` ). | `'messages'` |\n| `mcpEndpoint` | La ruta del punto final base para las operaciones MCP (utilizada con el transporte `STREAMABLE_HTTP` ). | `'mcp'` |\n| `globalApiPrefix` | Un prefijo global para todos los puntos finales de MCP. Útil si se integra en una aplicación existente. | `''` |\n| `guards` | Una matriz de protectores NestJS para aplicar a los puntos finales de MCP para autenticación/autorización. | `[]` |\n| `decorators` | Una matriz de decoradores de clase NestJS para aplicar a los controladores MCP generados. | `[]` |\n| `sse` | Configuración específica del transporte `SSE` . | `{ pingEnabled: true, pingIntervalMs: 30000 }` |\n| `sse.pingEnabled` | Si se deben habilitar mensajes de ping SSE periódicos para mantener la conexión activa. | `true` |\n| `sse.pingIntervalMs` | El intervalo (en milisegundos) para enviar mensajes de ping SSE. | `30000` |\n| `streamableHttp` | Configuración específica del transporte `STREAMABLE_HTTP` . | `{ enableJsonResponse: true, sessionIdGenerator: undefined, statelessMode: true }` |\n| `streamableHttp.enableJsonResponse` | Si `true` , permite que el punto final `/mcp` devuelva respuestas JSON para solicitudes que no son de transmisión (como `listTools` ). | `true` |\n| `streamableHttp.sessionIdGenerator` | Una función para generar identificadores de sesión únicos al ejecutarse en modo con estado. Obligatorio si `statelessMode` es `false` . | `undefined` |\n| `streamableHttp.statelessMode` | Si `true` , el transporte `STREAMABLE_HTTP` funciona sin estado (sin sesiones). Si es `false` , funciona con estado, lo que requiere un `sessionIdGenerator` . | `true` |","Spanish","es-ES",{"_36":62,"_40":66,"_45":67},{"_38":63,"_40":64,"_42":65},"Server-Sent Events トランスポートを備えた MCP サーバーとしてサービスを公開し、クライアントによるツールの検出と実行を容易にする NestJS モジュール。","NestJS MCP サーバーモジュール","# NestJS MCP サーバーモジュール\n\n[![CI](https://github.com/rekog-labs/MCP-Nest/actions/workflows/pipeline.yml/badge.svg)](https://github.com/rekog-labs/MCP-Nest/actions/workflows/pipeline.yml) [![コードカバレッジ](https://codecov.io/gh/rekog-labs/mcp-nest/branch/main/graph/badge.svg)](https://codecov.io/gh/rekog-labs/mcp-nest) [![NPMバージョン](https://img.shields.io/npm/v/@rekog/mcp-nest)](https://www.npmjs.com/package/@rekog/mcp-nest) [![NPMダウンロード](https://img.shields.io/npm/dm/@rekog/mcp-nest)](https://www.npmjs.com/package/@rekog/mcp-nest) [![NPMライセンス](https://img.shields.io/npm/l/@rekog/mcp-nest)](https://www.npmjs.com/package/@rekog/mcp-nest)\n\n\\*\\*モデルコンテキストプロトコル (MCP)\\*\\*を使用して、NestJS アプリケーションから AI 用のツール、リソース、プロンプトを簡単に公開できる NestJS モジュールです。\n\n`@rekog/mcp-nest`を使用すると、NestJS で使い慣れた方法でツール、リソース、プロンプトを定義し、依存性注入の機能をフルに活用して、既存のコードベースを利用して複雑なエンタープライズ対応の MCP サーバーを構築できます。\n\n## 特徴\n\n* 🚀 すべてのトランスポートタイプをサポート:\n * ストリーミング可能なHTTP\n * HTTP+SSE\n * 標準入出力\n* 🔍 自動`tool` 、 `resource` 、 `prompt`検出と登録\n* 💯 Zodベースのツール呼び出し検証\n* 📊 進捗通知\n* 🔒 ガードベースの認証\n* 🌐 MCP リソース (ツール、リソース、プロンプト) 内の HTTP リクエスト情報へのアクセス\n\n## インストール\n\n```bash\nnpm install @rekog/mcp-nest @modelcontextprotocol/sdk zod\n```\n\n## クイックスタート\n\n### 1. モジュールのインポート\n\n```typescript\n// app.module.ts\nimport { Module } from '@nestjs/common';\nimport { McpModule } from '@rekog/mcp-nest';\nimport { GreetingTool } from './greeting.tool';\n\n@Module({\n imports: [\n McpModule.forRoot({\n name: 'my-mcp-server',\n version: '1.0.0',\n }),\n ],\n providers: [GreetingTool],\n})\nexport class AppModule {}\n```\n\n### 2. ツールとリソースを定義する\n\n```typescript\n// greeting.tool.ts\nimport type { Request } from 'express';\nimport { Injectable } from '@nestjs/common';\nimport { Tool, Resource, Context } from '@rekog/mcp-nest';\nimport { z } from 'zod';\nimport { Progress } from '@modelcontextprotocol/sdk/types';\n\n@Injectable()\nexport class GreetingTool {\n constructor() {}\n\n @Tool({\n name: 'hello-world',\n description:\n 'Returns a greeting and simulates a long operation with progress updates',\n parameters: z.object({\n name: z.string().default('World'),\n }),\n })\n async sayHello({ name }, context: Context, request: Request) {\n const userAgent = request.get('user-agent') || 'Unknown';\n const greeting = `Hello, ${name}! Your user agent is: ${userAgent}`;\n const totalSteps = 5;\n for (let i = 0; i < totalSteps; i++) {\n await new Promise((resolve) => setTimeout(resolve, 100));\n\n // Send a progress update.\n await context.reportProgress({\n progress: (i + 1) * 20,\n total: 100,\n } as Progress);\n }\n\n return {\n content: [{ type: 'text', text: greeting }],\n };\n }\n\n @Resource({\n uri: 'mcp://hello-world/{userName}',\n name: 'Hello World',\n description: 'A simple greeting resource',\n mimeType: 'text/plain',\n })\n // Different from the SDK, we put the parameters and URI in the same object.\n async getCurrentSchema({ uri, userName }) {\n return {\n content: [\n {\n uri,\n text: `User is ${userName}`,\n mimeType: 'text/plain',\n },\n ],\n };\n }\n}\n```\n\n完了です！\n\n> \\[!TIP] 上記の例は、MCPツール内でHTTP `Request`ヘッダーにアクセスする方法を示しています。これは、ユーザーの識別、クライアント固有のロジックの追加など、様々なユースケースに役立ちます。その他の例については、[認証テスト](./tests/mcp-tool-auth.spec.ts)をご覧ください。\n\n## STDIO のクイックスタート\n\n主な違いは、モジュールをインポートするときに`transport`オプションを指定する必要があることです。\n\n```typescript\nMcpModule.forRoot({\n name: 'playground-stdio-server',\n version: '0.0.1',\n transport: McpTransportType.STDIO,\n});\n```\n\n残りは通常通り、ツール、リソース、プロンプトを定義できます。STDIOトランスポートを使用したスタンドアロンのNestJSアプリケーションの例を以下に示します。\n\n```typescript\nasync function bootstrap() {\n const app = await NestFactory.createApplicationContext(AppModule, {\n logger: false,\n });\n return app.close();\n}\n\nvoid bootstrap();\n```\n\n次に、MCP サーバーを MCP Stdio クライアントと共に使用するか ([例を参照](playground/clients/stdio-client.ts))、プロジェクトをビルドした後に次の MCP クライアント構成で使用することができます。\n\n```json\n{\n \"mcpServers\": {\n \"greeting\": {\n \"command\": \"node\",\n \"args\": [\n \"\",\n ]\n }\n }\n}\n```\n\n## APIエンドポイント\n\nHTTP + SSE トランスポートは 2 つのエンドポイントを公開します。\n\n* `GET /sse` : SSE 接続エンドポイント (構成されている場合はガードによって保護されます)\n* `POST /messages` : ツール実行エンドポイント (設定によりガードで保護されます)\n\nストリーミング可能な HTTP トランスポートは、次のエンドポイントを公開します。\n\n* `POST /mcp` : すべてのMCP操作（ツール実行、リソースアクセスなど）のメインエンドポイント。ステートフルモードでは、セッションの作成と維持を行います。\n* `GET /mcp` : リアルタイム更新と進捗状況通知のための Server-Sent Events (SSE) ストリームを確立します。**ステートフルモードでのみ利用可能です。**\n* `DELETE /mcp` : MCPセッションを終了します。**ステートフルモードでのみ使用できます。**\n\n### ヒント\n\nグローバルプレフィックス付きのモジュールを使用することもできますが、次のようにしてそれらのエンドポイントを除外することをお勧めします。\n\n```typescript\napp.setGlobalPrefix('/api', { exclude: ['sse', 'messages', 'mcp'] });\n```\n\n## 認証\n\n標準の NestJS Guards を使用して MCP エンドポイントを保護できます。\n\n### 1. ガードを作成する\n\n`CanActivate`インターフェースを実装します。ガードはリクエストの検証（JWTやAPIキーのチェックなど）を処理し、必要に応じてユーザー情報をリクエストオブジェクトに添付する必要があります。\n\n特別なことは何もありません。詳細については、NestJS のドキュメントを確認してください。\n\n### 2. ガードをつける\n\n`McpModule.forRoot`設定にガードを渡してください。ガードは`/sse`と`/messages`両方のエンドポイントに適用されます。\n\n```typescript\n// app.module.ts\nimport { Module } from '@nestjs/common';\nimport { McpModule } from '@rekog/mcp-nest';\nimport { GreetingTool } from './greeting.tool';\nimport { AuthGuard } from './auth.guard';\n\n@Module({\n imports: [\n McpModule.forRoot({\n name: 'my-mcp-server',\n version: '1.0.0',\n guards: [AuthGuard], // Apply the guard here\n }),\n ],\n providers: [GreetingTool, AuthGuard], // Ensure the Guard is also provided\n})\nexport class AppModule {}\n```\n\n以上です！残りはNestJS Guardsと同じです。\n\n## 遊び場\n\n`playground`ディレクトリには、MCPと`@rekog/mcp-nest`機能を簡単にテストするためのサンプルが含まれています。詳細は[`playground/README.md`](playground/README.md)を参照してください。\n\n## 構成\n\n`McpModule.forRoot()`メソッドは、サーバーの設定に使用する`McpOptions`オブジェクトを受け取ります。使用可能なオプションは以下のとおりです。\n\n| オプション | 説明 | デフォルト |\n| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |\n| `name` | **必須。MCP**サーバーの名前。 | - |\n| `version` | **必須。MCP**サーバーのバージョン。 | - |\n| `capabilities` | オプションのMCPサーバー機能をアドバタイズします。 [@modelcontextprotocol/sdk](https://www.npmjs.com/package/@modelcontextprotocol/sdk)を参照してください。 | `undefined` |\n| `instructions` | サーバーと対話する方法に関するクライアントへのオプションの指示。 | `undefined` |\n| `transport` | 有効にするトランスポートタイプを指定します。 | `[McpTransportType.SSE, McpTransportType.STREAMABLE_HTTP, McpTransportType.STDIO]` |\n| `sseEndpoint` | SSE 接続のエンドポイントパス ( `SSE`トランスポートで使用)。 | `'sse'` |\n| `messagesEndpoint` | メッセージを送信するためのエンドポイントパス ( `SSE`トランスポートで使用されます)。 | `'messages'` |\n| `mcpEndpoint` | MCP 操作の基本エンドポイントパス ( `STREAMABLE_HTTP`トランスポートで使用されます)。 | `'mcp'` |\n| `globalApiPrefix` | すべてのMCPエンドポイントのグローバルプレフィックス。既存のアプリケーションに統合する場合に便利です。 | `''` |\n| `guards` | 認証/承認のために MCP エンドポイントに適用する NestJS ガード配列。 | `[]` |\n| `decorators` | 生成された MCP コントローラーに適用する NestJS クラスデコレーターの配列。 | `[]` |\n| `sse` | `SSE`トランスポートに固有の構成。 | `{ pingEnabled: true, pingIntervalMs: 30000 }` |\n| `sse.pingEnabled` | 接続を維持するために定期的な SSE ping メッセージを有効にするかどうか。 | `true` |\n| `sse.pingIntervalMs` | SSE ping メッセージを送信する間隔 (ミリ秒単位)。 | `30000` |\n| `streamableHttp` | `STREAMABLE_HTTP`トランスポートに固有の構成。 | `{ enableJsonResponse: true, sessionIdGenerator: undefined, statelessMode: true }` |\n| `streamableHttp.enableJsonResponse` | `true`の場合、 `/mcp`エンドポイントは非ストリーミングリクエスト ( `listTools`など) に対して JSON 応答を返すことができます。 | `true` |\n| `streamableHttp.sessionIdGenerator` | `statelessMode`モードで実行しているときに一意のセッション ID を生成する関数。statelessMode が`false`場合に必須です。 | `undefined` |\n| `streamableHttp.statelessMode` | `true`の場合、 `STREAMABLE_HTTP`トランスポートはステートレス（セッションなし）で動作します。 `false`の場合、ステートフルで動作し、 `sessionIdGenerator`が必要になります。 | `true` |","Japanese","ja-JP",{"_36":69,"_40":73,"_45":74},{"_38":70,"_40":71,"_42":72},"서비스가 Server-Sent Events 전송을 통해 MCP 서버로 노출될 수 있도록 하는 NestJS 모듈로, 클라이언트가 도구를 검색하고 실행할 수 있도록 돕습니다.","NestJS MCP 서버 모듈","# NestJS MCP 서버 모듈\n\n[![씨아이](https://github.com/rekog-labs/MCP-Nest/actions/workflows/pipeline.yml/badge.svg)](https://github.com/rekog-labs/MCP-Nest/actions/workflows/pipeline.yml) [![코드 커버리지](https://codecov.io/gh/rekog-labs/mcp-nest/branch/main/graph/badge.svg)](https://codecov.io/gh/rekog-labs/mcp-nest) [![NPM 버전](https://img.shields.io/npm/v/@rekog/mcp-nest)](https://www.npmjs.com/package/@rekog/mcp-nest) [![NPM 다운로드](https://img.shields.io/npm/dm/@rekog/mcp-nest)](https://www.npmjs.com/package/@rekog/mcp-nest) [![NPM 라이센스](https://img.shields.io/npm/l/@rekog/mcp-nest)](https://www.npmjs.com/package/@rekog/mcp-nest)\n\n**MCP(Model Context Protocol)를** 사용하여 NestJS 애플리케이션에서 AI를 위한 도구, 리소스 및 프롬프트를 손쉽게 노출할 수 있는 NestJS 모듈입니다.\n\n`@rekog/mcp-nest` 사용하면 NestJS에서 익숙한 방식으로 도구, 리소스, 프롬프트를 정의하고 종속성 주입의 모든 기능을 활용하여 기존 코드베이스를 활용하여 복잡한 엔터프라이즈급 MCP 서버를 구축할 수 있습니다.\n\n## 특징\n\n* 🚀 모든 전송 유형 지원:\n * 스트리밍 가능한 HTTP\n * HTTP+SSE\n * 스튜디오\n* 🔍 자동 `tool` , `resource` , `prompt` 검색 및 등록\n* 💯 Zod 기반 도구 호출 검증\n* 📊 진행 상황 알림\n* 🔒 가드 기반 인증\n* 🌐 MCP 리소스(도구, 리소스, 프롬프트) 내 HTTP 요청 정보에 대한 액세스\n\n## 설치\n\n지엑스피1\n\n## 빠른 시작\n\n### 1. 모듈 가져오기\n\n```typescript\n// app.module.ts\nimport { Module } from '@nestjs/common';\nimport { McpModule } from '@rekog/mcp-nest';\nimport { GreetingTool } from './greeting.tool';\n\n@Module({\n imports: [\n McpModule.forRoot({\n name: 'my-mcp-server',\n version: '1.0.0',\n }),\n ],\n providers: [GreetingTool],\n})\nexport class AppModule {}\n```\n\n### 2. 도구 및 리소스 정의\n\n```typescript\n// greeting.tool.ts\nimport type { Request } from 'express';\nimport { Injectable } from '@nestjs/common';\nimport { Tool, Resource, Context } from '@rekog/mcp-nest';\nimport { z } from 'zod';\nimport { Progress } from '@modelcontextprotocol/sdk/types';\n\n@Injectable()\nexport class GreetingTool {\n constructor() {}\n\n @Tool({\n name: 'hello-world',\n description:\n 'Returns a greeting and simulates a long operation with progress updates',\n parameters: z.object({\n name: z.string().default('World'),\n }),\n })\n async sayHello({ name }, context: Context, request: Request) {\n const userAgent = request.get('user-agent') || 'Unknown';\n const greeting = `Hello, ${name}! Your user agent is: ${userAgent}`;\n const totalSteps = 5;\n for (let i = 0; i < totalSteps; i++) {\n await new Promise((resolve) => setTimeout(resolve, 100));\n\n // Send a progress update.\n await context.reportProgress({\n progress: (i + 1) * 20,\n total: 100,\n } as Progress);\n }\n\n return {\n content: [{ type: 'text', text: greeting }],\n };\n }\n\n @Resource({\n uri: 'mcp://hello-world/{userName}',\n name: 'Hello World',\n description: 'A simple greeting resource',\n mimeType: 'text/plain',\n })\n // Different from the SDK, we put the parameters and URI in the same object.\n async getCurrentSchema({ uri, userName }) {\n return {\n content: [\n {\n uri,\n text: `User is ${userName}`,\n mimeType: 'text/plain',\n },\n ],\n };\n }\n}\n```\n\n완료되었습니다!\n\n> \\[!TIP] 위 예제는 MCP 도구 내에서 HTTP `Request` 헤더에 액세스하는 방법을 보여줍니다. 이는 사용자 식별, 클라이언트별 로직 추가 및 기타 여러 사용 사례에 유용합니다. 더 많은 예제는 [인증 테스트를](./tests/mcp-tool-auth.spec.ts) 참조하세요.\n\n## STDIO 빠른 시작\n\n가장 큰 차이점은 모듈을 가져올 때 `transport` 옵션을 제공해야 한다는 것입니다.\n\n```typescript\nMcpModule.forRoot({\n name: 'playground-stdio-server',\n version: '0.0.1',\n transport: McpTransportType.STDIO,\n});\n```\n\n나머지는 동일하며, 평소처럼 도구, 리소스, 프롬프트를 정의할 수 있습니다. STDIO 전송을 사용하는 독립형 NestJS 애플리케이션의 예는 다음과 같습니다.\n\n```typescript\nasync function bootstrap() {\n const app = await NestFactory.createApplicationContext(AppModule, {\n logger: false,\n });\n return app.close();\n}\n\nvoid bootstrap();\n```\n\n다음으로, MCP Stdio 클라이언트와 함께 MCP 서버를 사용할 수 있습니다( [예 참조](playground/clients/stdio-client.ts) ). 또는 프로젝트를 빌드한 후 다음 MCP 클라이언트 구성과 함께 사용할 수 있습니다.\n\n```json\n{\n \"mcpServers\": {\n \"greeting\": {\n \"command\": \"node\",\n \"args\": [\n \"\",\n ]\n }\n }\n}\n```\n\n## API 엔드포인트\n\nHTTP+SSE 전송은 두 개의 엔드포인트를 노출합니다.\n\n* `GET /sse` : SSE 연결 엔드포인트(구성된 경우 가드로 보호됨)\n* `POST /messages` : 도구 실행 엔드포인트(구성된 경우 가드로 보호됨)\n\n스트리밍 가능한 HTTP 전송은 다음 엔드포인트를 노출합니다.\n\n* `POST /mcp` : 모든 MCP 작업(도구 실행, 리소스 액세스 등)의 주요 엔드포인트입니다. 상태 저장 모드에서는 세션을 생성하고 유지합니다.\n* `GET /mcp` : 실시간 업데이트 및 진행 상황 알림을 위한 서버 전송 이벤트(SSE) 스트림을 설정합니다. **상태 저장 모드에서만 사용 가능합니다.**\n* `DELETE /mcp` : MCP 세션을 종료합니다. **상태 저장 모드에서만 사용 가능합니다.**\n\n### 팁\n\n글로벌 접두사를 사용하여 모듈을 사용할 수 있지만 권장되는 방법은 다음을 사용하여 해당 엔드포인트를 제외하는 것입니다.\n\n```typescript\napp.setGlobalPrefix('/api', { exclude: ['sse', 'messages', 'mcp'] });\n```\n\n## 입증\n\n표준 NestJS Guards를 사용하여 MCP 엔드포인트를 보호할 수 있습니다.\n\n### 1. 가드 생성\n\n`CanActivate` 인터페이스를 구현합니다. 가드는 요청 검증(예: JWT, API 키 확인)을 처리하고, 선택적으로 사용자 정보를 요청 객체에 첨부해야 합니다.\n\n특별한 것은 없습니다. 자세한 내용은 NestJS 문서를 확인하세요.\n\n### 2. 가드를 적용하세요\n\n가드를 `McpModule.forRoot` 구성으로 전달하세요. 가드는 `/sse` 및 `/messages` 엔드포인트 모두에 적용됩니다.\n\n```typescript\n// app.module.ts\nimport { Module } from '@nestjs/common';\nimport { McpModule } from '@rekog/mcp-nest';\nimport { GreetingTool } from './greeting.tool';\nimport { AuthGuard } from './auth.guard';\n\n@Module({\n imports: [\n McpModule.forRoot({\n name: 'my-mcp-server',\n version: '1.0.0',\n guards: [AuthGuard], // Apply the guard here\n }),\n ],\n providers: [GreetingTool, AuthGuard], // Ensure the Guard is also provided\n})\nexport class AppModule {}\n```\n\n이게 전부입니다! 나머지는 NestJS Guards와 동일합니다.\n\n## 운동장\n\n`playground` 디렉터리에는 MCP 및 `@rekog/mcp-nest` 기능을 빠르게 테스트할 수 있는 예제가 포함되어 있습니다. 자세한 내용은 [`playground/README.md`](playground/README.md) 를 참조하세요.\n\n## 구성\n\n`McpModule.forRoot()` 메서드는 `McpOptions` 객체를 사용하여 서버를 구성합니다. 사용 가능한 옵션은 다음과 같습니다.\n\n| 옵션 | 설명 | 기본 |\n| ----------------------------------- | --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |\n| `name` | **필수.** MCP 서버 이름입니다. | - |\n| `version` | **필수.** MCP 서버의 버전입니다. | - |\n| `capabilities` | 광고를 위한 선택적 MCP 서버 기능입니다. [@modelcontextprotocol/sdk를](https://www.npmjs.com/package/@modelcontextprotocol/sdk) 참조하세요. | `undefined` |\n| `instructions` | 클라이언트가 서버와 상호 작용하는 방법에 대한 선택적 지침입니다. | `undefined` |\n| `transport` | 활성화할 전송 유형을 지정합니다. | `[McpTransportType.SSE, McpTransportType.STREAMABLE_HTTP, McpTransportType.STDIO]` |\n| `sseEndpoint` | SSE 연결에 대한 종료점 경로( `SSE` 전송과 함께 사용됨). | `'sse'` |\n| `messagesEndpoint` | 메시지를 전송하기 위한 엔드포인트 경로( `SSE` 전송과 함께 사용). | `'messages'` |\n| `mcpEndpoint` | MCP 작업을 위한 기본 엔드포인트 경로( `STREAMABLE_HTTP` 전송과 함께 사용됨). | `'mcp'` |\n| `globalApiPrefix` | 모든 MCP 엔드포인트에 대한 글로벌 접두사입니다. 기존 애플리케이션에 통합할 때 유용합니다. | `''` |\n| `guards` | 인증/권한 부여를 위해 MCP 엔드포인트에 적용할 NestJS Guard 배열입니다. | `[]` |\n| `decorators` | 생성된 MCP 컨트롤러에 적용할 NestJS 클래스 데코레이터의 배열입니다. | `[]` |\n| `sse` | `SSE` 전송에 특화된 구성입니다. | `{ pingEnabled: true, pingIntervalMs: 30000 }` |\n| `sse.pingEnabled` | 연결을 유지하기 위해 주기적 SSE ping 메시지를 활성화할지 여부입니다. | `true` |\n| `sse.pingIntervalMs` | SSE ping 메시지를 보내는 간격(밀리초)입니다. | `30000` |\n| `streamableHttp` | `STREAMABLE_HTTP` 전송에 특화된 구성입니다. | `{ enableJsonResponse: true, sessionIdGenerator: undefined, statelessMode: true }` |\n| `streamableHttp.enableJsonResponse` | `true` 인 경우 `/mcp` 엔드포인트가 스트리밍이 아닌 요청(예: `listTools` )에 대한 JSON 응답을 반환할 수 있습니다. | `true` |\n| `streamableHttp.sessionIdGenerator` | 상태 저장 모드에서 실행할 때 고유한 세션 ID를 생성하는 함수입니다. `statelessMode` 가 `false` 인 경우 필수입니다. | `undefined` |\n| `streamableHttp.statelessMode` | `true` 이면 `STREAMABLE_HTTP` 전송은 상태 비저장(세션 없음)으로 작동합니다. `false` 이면 상태 저장( `sessionIdGenerator` 가 필요합니다. | `true` |","Korean","ko-KR",{"_36":76,"_40":80,"_45":81},{"_38":77,"_40":78,"_42":79},"Модуль NestJS, который позволяет отображать службы как сервер MCP с транспортом событий, отправленных сервером, что упрощает обнаружение и выполнение инструментов клиентами.","Модуль сервера NestJS MCP","# Модуль сервера NestJS MCP\n\n[![КИ](https://github.com/rekog-labs/MCP-Nest/actions/workflows/pipeline.yml/badge.svg)](https://github.com/rekog-labs/MCP-Nest/actions/workflows/pipeline.yml) [![Покрытие кода](https://codecov.io/gh/rekog-labs/mcp-nest/branch/main/graph/badge.svg)](https://codecov.io/gh/rekog-labs/mcp-nest) [![Версия НПМ](https://img.shields.io/npm/v/@rekog/mcp-nest)](https://www.npmjs.com/package/@rekog/mcp-nest) [![Загрузки НПМ](https://img.shields.io/npm/dm/@rekog/mcp-nest)](https://www.npmjs.com/package/@rekog/mcp-nest) [![Лицензия НПМ](https://img.shields.io/npm/l/@rekog/mcp-nest)](https://www.npmjs.com/package/@rekog/mcp-nest)\n\nМодуль NestJS для легкого предоставления инструментов, ресурсов и подсказок для ИИ из ваших приложений NestJS с использованием **протокола контекста модели (MCP)** .\n\nС помощью `@rekog/mcp-nest` вы определяете инструменты, ресурсы и запросы так, как это привычно в NestJS, и используете всю мощь внедрения зависимостей, чтобы использовать существующую кодовую базу для создания сложных корпоративных серверов MCP.\n\n## Функции\n\n* 🚀 Поддержка всех типов транспорта:\n * Потоковое HTTP\n * HTTP+SSE\n * СТДИО\n* 🔍 Автоматическое обнаружение и регистрация `tool` , `resource` и `prompt`\n* 💯 Проверка вызова инструмента на основе Zod\n* 📊 Уведомления о ходе выполнения\n* 🔒 Аутентификация на основе Guard\n* 🌐 Доступ к информации HTTP-запроса в ресурсах MCP (инструменты, ресурсы, подсказки)\n\n## Установка\n\n```bash\nnpm install @rekog/mcp-nest @modelcontextprotocol/sdk zod\n```\n\n## Быстрый старт\n\n### 1. Модуль импорта\n\n```typescript\n// app.module.ts\nimport { Module } from '@nestjs/common';\nimport { McpModule } from '@rekog/mcp-nest';\nimport { GreetingTool } from './greeting.tool';\n\n@Module({\n imports: [\n McpModule.forRoot({\n name: 'my-mcp-server',\n version: '1.0.0',\n }),\n ],\n providers: [GreetingTool],\n})\nexport class AppModule {}\n```\n\n### 2. Определите инструменты и ресурсы\n\n```typescript\n// greeting.tool.ts\nimport type { Request } from 'express';\nimport { Injectable } from '@nestjs/common';\nimport { Tool, Resource, Context } from '@rekog/mcp-nest';\nimport { z } from 'zod';\nimport { Progress } from '@modelcontextprotocol/sdk/types';\n\n@Injectable()\nexport class GreetingTool {\n constructor() {}\n\n @Tool({\n name: 'hello-world',\n description:\n 'Returns a greeting and simulates a long operation with progress updates',\n parameters: z.object({\n name: z.string().default('World'),\n }),\n })\n async sayHello({ name }, context: Context, request: Request) {\n const userAgent = request.get('user-agent') || 'Unknown';\n const greeting = `Hello, ${name}! Your user agent is: ${userAgent}`;\n const totalSteps = 5;\n for (let i = 0; i < totalSteps; i++) {\n await new Promise((resolve) => setTimeout(resolve, 100));\n\n // Send a progress update.\n await context.reportProgress({\n progress: (i + 1) * 20,\n total: 100,\n } as Progress);\n }\n\n return {\n content: [{ type: 'text', text: greeting }],\n };\n }\n\n @Resource({\n uri: 'mcp://hello-world/{userName}',\n name: 'Hello World',\n description: 'A simple greeting resource',\n mimeType: 'text/plain',\n })\n // Different from the SDK, we put the parameters and URI in the same object.\n async getCurrentSchema({ uri, userName }) {\n return {\n content: [\n {\n uri,\n text: `User is ${userName}`,\n mimeType: 'text/plain',\n },\n ],\n };\n }\n}\n```\n\nГотово!\n\n> \\[!TIP] В примере выше показано, как осуществляется доступ к заголовкам HTTP- `Request` в MCP Tools. Это пол��зно для идентификации пользователей, добавления клиентской логики и многих других вариантов использования. Дополнительные примеры см. в разделе [Тесты аутентификации](./tests/mcp-tool-auth.spec.ts) .\n\n## Быстрый старт для STDIO\n\nГлавное отличие заключается в том, что при импорте модуля необходимо указать опцию `transport` .\n\n```typescript\nMcpModule.forRoot({\n name: 'playground-stdio-server',\n version: '0.0.1',\n transport: McpTransportType.STDIO,\n});\n```\n\nОстальное то же самое, вы можете определить инструменты, ресурсы и подсказки как обычно. Пример автономного приложения NestJS, использующего транспорт STDIO, следующий:\n\n```typescript\nasync function bootstrap() {\n const app = await NestFactory.createApplicationContext(AppModule, {\n logger: false,\n });\n return app.close();\n}\n\nvoid bootstrap();\n```\n\nДалее вы можете использовать сервер MCP с клиентом MCP Stdio ( [см. пример](playground/clients/stdio-client.ts) ) или после сборки проекта вы можете использовать его со следующей конфигурацией клиента MCP:\n\n```json\n{\n \"mcpServers\": {\n \"greeting\": {\n \"command\": \"node\",\n \"args\": [\n \"\",\n ]\n }\n }\n}\n```\n\n## Конечные точки API\n\nТранспорт HTTP+SSE предоставляет две конечные точки:\n\n* `GET /sse` : конечная точка соединения SSE (защищена защитой, если настроена)\n* `POST /messages` : Конечная точка выполнения инструмента (защищена защитой, если настроена)\n\nПотоковый HTTP-транспорт предоставляет следующие конечные точки:\n\n* `POST /mcp` : Основная конечная точка для всех операций MCP (выполнение инструмента, доступ к ресурсам и т. д.). В режиме сохранения состояния создает и поддерживает сеансы.\n* `GET /mcp` : Устанавливает потоки Server-Sent Events (SSE) для обновлений в реальном времени и уведомлений о ходе выполнения. **Доступно только в режиме с отслеживанием состояния.**\n* `DELETE /mcp` : Завершает сеансы MCP. **Доступно только в режиме с отслеживанием состояния.**\n\n### Советы\n\nМожно использовать модуль с глобальным префиксом, но рекомендуется исключить эти конечные точки с помощью:\n\n```typescript\napp.setGlobalPrefix('/api', { exclude: ['sse', 'messages', 'mcp'] });\n```\n\n## Аутентификация\n\nВы можете защитить свои конечные точки MCP с помощью стандартных средств защиты NestJS.\n\n### 1. Создайте стражу\n\nРеализуйте интерфейс `CanActivate` . Guard должен обрабатывать проверку запроса (например, проверку JWT, ключей API) и опционально прикреплять информацию о пользователе к объекту запроса.\n\nНичего особенного, более подробную информацию можно найти в документации NestJS.\n\n### 2. Применить защиту\n\nПередайте ваши защитные меры в конфигурацию `McpModule.forRoot` . Защитные меры будут применены к обеим конечным точкам `/sse` и `/messages` .\n\n```typescript\n// app.module.ts\nimport { Module } from '@nestjs/common';\nimport { McpModule } from '@rekog/mcp-nest';\nimport { GreetingTool } from './greeting.tool';\nimport { AuthGuard } from './auth.guard';\n\n@Module({\n imports: [\n McpModule.forRoot({\n name: 'my-mcp-server',\n version: '1.0.0',\n guards: [AuthGuard], // Apply the guard here\n }),\n ],\n providers: [GreetingTool, AuthGuard], // Ensure the Guard is also provided\n})\nexport class AppModule {}\n```\n\nВот и все! Остальное то же самое, что и у NestJS Guards.\n\n## Детская площадка\n\nКаталог `playground` содержит примеры для быстрого тестирования функций MCP и `@rekog/mcp-nest` . Более подробную информацию см. в [`playground/README.md`](playground/README.md) .\n\n## Конфигурация\n\nМетод `McpModule.forRoot()` принимает объект `McpOptions` для настройки сервера. Вот доступные параметры:\n\n| Вариант | Описание | По умолчанию |\n| ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |\n| `name` | **Обязательно.** Имя вашего MCP-сервера. | - |\n| `version` | **Обязательно.** Версия вашего сервера MCP. | - |\n| `capabilities` | Дополнительные возможности сервера MCP для рекламы. См. [@modelcontextprotocol/sdk](https://www.npmjs.com/package/@modelcontextprotocol/sdk) . | `undefined` |\n| `instructions` | Дополнительные инструкции для клиента по взаимодействию с сервером. | `undefined` |\n| `transport` | Указывает тип(ы) транспорта, которые необходимо включить. | `[McpTransportType.SSE, McpTransportType.STREAMABLE_HTTP, McpTransportType.STDIO]` |\n| `sseEndpoint` | Путь конечной точки для соединения SSE (используется с транспортом `SSE` ). | `'sse'` |\n| `messagesEndpoint` | Конечный путь для отправки сообщений (используется с транспортом `SSE` ). | `'messages'` |\n| `mcpEndpoint` | Базовый путь конечной точки для операций MCP (используется с транспортом `STREAMABLE_HTTP` ). | `'mcp'` |\n| `globalApiPrefix` | Глобальный префикс для всех конечных точек MCP. Полезно при интеграции в существующее приложение. | `''` |\n| `guards` | Массив NestJS Guards для применения к конечным точкам MCP для аутентификации/авторизации. | `[]` |\n| `decorators` | Массив декораторов классов NestJS для применения к сгенерированным контроллерам MCP. | `[]` |\n| `sse` | Конфигурация, специфичная для транспорта `SSE` . | `{ pingEnabled: true, pingIntervalMs: 30000 }` |\n| `sse.pingEnabled` | Следует ли включать периодические сообщения SSE ping для поддержания соединения. | `true` |\n| `sse.pingIntervalMs` | Интервал (в миллисекундах) отправки сообщений SSE ping. | `30000` |\n| `streamableHttp` | Конфигурация, специфичная для транспорта `STREAMABLE_HTTP` . | `{ enableJsonResponse: true, sessionIdGenerator: undefined, statelessMode: true }` |\n| `streamableHttp.enableJsonResponse` | Если `true` , позволяет конечной точке `/mcp` возвращать ответы JSON для непотоковых запросов (например, `listTools` ). | `true` |\n| `streamableHttp.sessionIdGenerator` | Функция для генерации уникальных идентификаторов сеансов при работе в режиме с сохранением состояния. Требуется, если `statelessMode` имеет значение `false` . | `undefined` |\n| `streamableHttp.statelessMode` | Если `true` , транспорт `STREAMABLE_HTTP` работает без сохранения состояния (без сессий). Если `false` , он работает с сохранением состояния, требуя `sessionIdGenerator` . | `true` |","Russian","ru-RU",{"_36":83,"_40":87,"_45":88},{"_38":84,"_40":85,"_42":86},"NestJS 模块允许将服务公开为具有服务器发送事件传输的 MCP 服务器，从而方便客户端发现和执行工具。","NestJS MCP 服务器模块","# NestJS MCP 服务器模块\n\n[![CI](https://github.com/rekog-labs/MCP-Nest/actions/workflows/pipeline.yml/badge.svg)](https://github.com/rekog-labs/MCP-Nest/actions/workflows/pipeline.yml) [![代码覆盖率](https://codecov.io/gh/rekog-labs/mcp-nest/branch/main/graph/badge.svg)](https://codecov.io/gh/rekog-labs/mcp-nest) [![NPM 版本](https://img.shields.io/npm/v/@rekog/mcp-nest)](https://www.npmjs.com/package/@rekog/mcp-nest) [![NPM 下载](https://img.shields.io/npm/dm/@rekog/mcp-nest)](https://www.npmjs.com/package/@rekog/mcp-nest) [![NPM 许可证](https://img.shields.io/npm/l/@rekog/mcp-nest)](https://www.npmjs.com/package/@rekog/mcp-nest)\n\nNestJS 模块可使用\\*\\*模型上下文协议 (MCP)\\*\\*从 NestJS 应用程序轻松公开 AI 的工具、资源和提示。\n\n使用`@rekog/mcp-nest`您可以按照 NestJS 中熟悉的方式定义工具、资源和提示，并充分利用依赖注入的全部功能，利用现有代码库构建复杂的企业级 MCP 服务器。\n\n## 特征\n\n* 🚀 支持所有运输类型：\n * 可流式传输的 HTTP\n * HTTP+SSE\n * 标准输出\n* 🔍 自动`tool` 、 `resource`和`prompt`发现和注册\n* 💯 基于 Zod 的工具调用验证\n* 📊 进度通知\n* 🔒 基于 Guard 的身份验证\n* 🌐 访问 MCP 资源（工具、资源、提示）中的 HTTP 请求信息\n\n## 安装\n\n```bash\nnpm install @rekog/mcp-nest @modelcontextprotocol/sdk zod\n```\n\n## 快速入门\n\n### 1.导入模块\n\n```typescript\n// app.module.ts\nimport { Module } from '@nestjs/common';\nimport { McpModule } from '@rekog/mcp-nest';\nimport { GreetingTool } from './greeting.tool';\n\n@Module({\n imports: [\n McpModule.forRoot({\n name: 'my-mcp-server',\n version: '1.0.0',\n }),\n ],\n providers: [GreetingTool],\n})\nexport class AppModule {}\n```\n\n### 2. 定义工具和资源\n\n```typescript\n// greeting.tool.ts\nimport type { Request } from 'express';\nimport { Injectable } from '@nestjs/common';\nimport { Tool, Resource, Context } from '@rekog/mcp-nest';\nimport { z } from 'zod';\nimport { Progress } from '@modelcontextprotocol/sdk/types';\n\n@Injectable()\nexport class GreetingTool {\n constructor() {}\n\n @Tool({\n name: 'hello-world',\n description:\n 'Returns a greeting and simulates a long operation with progress updates',\n parameters: z.object({\n name: z.string().default('World'),\n }),\n })\n async sayHello({ name }, context: Context, request: Request) {\n const userAgent = request.get('user-agent') || 'Unknown';\n const greeting = `Hello, ${name}! Your user agent is: ${userAgent}`;\n const totalSteps = 5;\n for (let i = 0; i < totalSteps; i++) {\n await new Promise((resolve) => setTimeout(resolve, 100));\n\n // Send a progress update.\n await context.reportProgress({\n progress: (i + 1) * 20,\n total: 100,\n } as Progress);\n }\n\n return {\n content: [{ type: 'text', text: greeting }],\n };\n }\n\n @Resource({\n uri: 'mcp://hello-world/{userName}',\n name: 'Hello World',\n description: 'A simple greeting resource',\n mimeType: 'text/plain',\n })\n // Different from the SDK, we put the parameters and URI in the same object.\n async getCurrentSchema({ uri, userName }) {\n return {\n content: [\n {\n uri,\n text: `User is ${userName}`,\n mimeType: 'text/plain',\n },\n ],\n };\n }\n}\n```\n\n您已完成！\n\n> 以上示例展示了如何在 MCP 工具中访问 HTTP `Request`标头。这对于识别用户、添加客户端特定逻辑以及许多其他用例非常有用。更多示例，请参阅[身份验证测试](./tests/mcp-tool-auth.spec.ts)。\n\n## STDIO 快速入门\n\n主要区别在于您需要在导入模块时提供`transport`选项。\n\n```typescript\nMcpModule.forRoot({\n name: 'playground-stdio-server',\n version: '0.0.1',\n transport: McpTransportType.STDIO,\n});\n```\n\n其余部分相同，您可以像往常一样定义工具、资源和提示。使用 STDIO 传输的独立 NestJS 应用程序示例如下：\n\n```typescript\nasync function bootstrap() {\n const app = await NestFactory.createApplicationContext(AppModule, {\n logger: false,\n });\n return app.close();\n}\n\nvoid bootstrap();\n```\n\n接下来，您可以将 MCP 服务器与 MCP Stdio 客户端一起使用（[参见示例](playground/clients/stdio-client.ts)），或者在构建项目后，您可以使用以下 MCP 客户端配置：\n\n```json\n{\n \"mcpServers\": {\n \"greeting\": {\n \"command\": \"node\",\n \"args\": [\n \"\",\n ]\n }\n }\n}\n```\n\n## API 端点\n\nHTTP+SSE 传输公开两个端点：\n\n* `GET /sse` ：SSE 连接端点（如果配置，则受保护）\n* `POST /messages` ：工具执行端点（如果配置，则受保护）\n\n可流式传输的 HTTP 传输公开以下端点：\n\n* `POST /mcp` ：所有 MCP 操作（工具执行、资源访问等）的主端点。在状态模式下，此端点用于创建并维护会话。\n* `GET /mcp` ：建立服务器发送事件 (SSE) 流，用于实时更新和进度通知。**仅在状态模式下可用。**\n* `DELETE /mcp` ：终止 MCP 会话。**仅在状态模式下可用。**\n\n### 尖端\n\n可以使用带有全局前缀的模块，但建议使用以下方法排除这些端点：\n\n```typescript\napp.setGlobalPrefix('/api', { exclude: ['sse', 'messages', 'mcp'] });\n```\n\n## 验证\n\n您可以使用标准 NestJS Guards 保护您的 MCP 端点。\n\n### 1. 创建一个守卫\n\n实现`CanActivate`接口。该守卫应该处理请求验证（例如，检查 JWT、API 密钥），并可选地将用户信息附加到请求对象。\n\n没什么特别的，请查看 NestJS 文档了解更多详细信息。\n\n### 2. 应用防护\n\n将您的防护传递给`McpModule.forRoot`配置。防护将同时应用于`/sse`和`/messages`端点。\n\n```typescript\n// app.module.ts\nimport { Module } from '@nestjs/common';\nimport { McpModule } from '@rekog/mcp-nest';\nimport { GreetingTool } from './greeting.tool';\nimport { AuthGuard } from './auth.guard';\n\n@Module({\n imports: [\n McpModule.forRoot({\n name: 'my-mcp-server',\n version: '1.0.0',\n guards: [AuthGuard], // Apply the guard here\n }),\n ],\n providers: [GreetingTool, AuthGuard], // Ensure the Guard is also provided\n})\nexport class AppModule {}\n```\n\n就是这样！其余部分与 NestJS Guards 相同。\n\n## 操场\n\n`playground`目录包含快速测试 MCP 和`@rekog/mcp-nest`功能的示例。更多详细信息，请参阅[`playground/README.md`](playground/README.md) 。\n\n## 配置\n\n`McpModule.forRoot()`方法接受一个`McpOptions`对象来配置服务器。可用的选项如下：\n\n| 选项 | 描述 | 默认 |\n| ----------------------------------- | ----------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |\n| `name` | \\*\\*必填项。\\*\\*您的 MCP 服务器的名称。 | - |\n| `version` | \\*\\*必填项。\\*\\*您的 MCP 服务器版本。 | - |\n| `capabilities` | 可选的 MCP 服务器功能可供宣传。请参阅[@modelcontextprotocol/sdk](https://www.npmjs.com/package/@modelcontextprotocol/sdk) 。 | `undefined` |\n| `instructions` | 客户端如何与服务器交互的可选说明。 | `undefined` |\n| `transport` | 指定要启用的传输类型。 | `[McpTransportType.SSE, McpTransportType.STREAMABLE_HTTP, McpTransportType.STDIO]` |\n| `sseEndpoint` | SSE 连接的端点路径（与`SSE`传输一起使用）。 | `'sse'` |\n| `messagesEndpoint` | 发送消息的端点路径（与`SSE`传输一起使用）。 | `'messages'` |\n| `mcpEndpoint` | MCP 操作的基本端点路径（与`STREAMABLE_HTTP`传输一起使用）。 | `'mcp'` |\n| `globalApiPrefix` | 所有 MCP 端点的全局前缀。在集成到现有应用程序时非常有用。 | `''` |\n| `guards` | 一组 NestJS Guards，应用于 MCP 端点进行身份验证/授权。 | `[]` |\n| `decorators` | 应用于生成的 MCP 控制器的 NestJS 类装饰器数组。 | `[]` |\n| `sse` | 特定于`SSE`传输的配置。 | `{ pingEnabled: true, pingIntervalMs: 30000 }` |\n| `sse.pingEnabled` | 是否启用定期 SSE ping 消息来保持连接处于活动状态。 | `true` |\n| `sse.pingIntervalMs` | 发送 SSE ping 消息的间隔（以毫秒为单位）。 | `30000` |\n| `streamableHttp` | 特定于`STREAMABLE_HTTP`传输的配置。 | `{ enableJsonResponse: true, sessionIdGenerator: undefined, statelessMode: true }` |\n| `streamableHttp.enableJsonResponse` | 如果为`true` ，则允许`/mcp`端点对非流式请求（如`listTools` ）返回 JSON 响应。 | `true` |\n| `streamableHttp.sessionIdGenerator` | 在有状态模式下运行时生成唯一会话 ID 的函数。当`statelessMode`为`false`时，此函数为必需。 | `undefined` |\n| `streamableHttp.statelessMode` | 如果为`true` ，则`STREAMABLE_HTTP`传输无状态运行（无会话）。如果为`false` ，则传输有状态运行，需要`sessionIdGenerator` 。 | `true` |","Chinese","zh-CN","githubUser","locale",{"_92":93,"_94":95,"_20":101,"_107":49,"_108":49,"_109":110,"_114":115,"_137":-5,"_23":138,"_139":140,"_141":142,"_40":50,"_167":128,"_168":169,"_173":-5,"_174":175,"_176":-5,"_177":178,"_183":-5,"_149":124,"_184":185,"_189":-5,"_8":190,"_191":192},"addedAt","2025-01-26T23:04:24.661661555Z","argumentsJsonSchema",{"_96":97,"_98":99,"_12":100},"properties",{},"required",[],"object",[102,103,104,105,106],"category:developer-tools","category:agent-orchestration","hosting:remote-capable","language:typescript","license_grade:a","descriptionMarkdown","descriptionPlainText","githubProject",{"_42":111,"_112":113},"# NestJS MCP Server Module\n\n

Rate & Review

MCP directory API