@rekog/mcp-nest 1.5.0 → 1.5.2

package/.github/workflows/pipeline.yml

@@ -1,4 +1,4 @@
-name: Node.js CI and Publish
+name: Tests
 
 on:
   push:
@@ -15,12 +15,22 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'
+
       - name: Install dependencies
         run: npm ci
+
       - name: Run tests
         run: npm run test
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main' && matrix.node-version == '20.x'
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage/lcov.info

package/README.md

@@ -1,18 +1,19 @@
 # NestJS MCP Server Module
 
-<p align="center">
+<div align="center">
   <img src="https://raw.githubusercontent.com/rekog-labs/MCP-Nest/main/image.png" height="200">
-</p>
 
-<p align="center">
-  <a href="https://www.npmjs.com/package/@rekog/mcp-nest" target="_blank"><img alt="npm version" src="https://img.shields.io/npm/v/@rekog/mcp-nest" /></a>
-  <a href="https://www.npmjs.com/package/@rekog/mcp-nest" target="_blank"><img alt="npm downloads" src="https://img.shields.io/npm/dm/@rekog/mcp-nest" /></a>
-  <a href="https://www.npmjs.com/package/@rekog/mcp-nest" target="_blank"><img alt="NPM" src="https://img.shields.io/npm/l/@rekog/mcp-nest" /></a>
-</p>
+[![CI][ci-image]][ci-url]
+[![Code Coverage][code-coverage-image]][code-coverage-url]
+[![NPM Version][npm-version-image]][npm-url]
+[![NPM Downloads][npm-downloads-image]][npm-url]
+[![NPM License][npm-license-image]][npm-url]
+
+</div>
 
 A NestJS module to effortlessly expose tools, resources, and prompts for AI, from your NestJS applications using the **Model Context Protocol (MCP)**.
 
-with `@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.
+With `@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.
 
 ## Features
 
@@ -24,6 +25,7 @@ with `@rekog/mcp-nest` you define tools, resources, and prompts in a way that's
 - 💯 Zod-based tool call validation
 - 📊 Progress notifications
 - 🔒 Guard-based authentication
+- 🌐 Access to HTTP Request information within MCP Resources (Tools, Resources, Prompts)
 
 ## Installation
 
@@ -57,6 +59,7 @@ export class AppModule {}
 
 ```typescript
 // greeting.tool.ts
+import type { Request } from 'express';
 import { Injectable } from '@nestjs/common';
 import { Tool, Resource, Context } from '@rekog/mcp-nest';
 import { z } from 'zod';
@@ -74,12 +77,12 @@ export class GreetingTool {
       name: z.string().default('World'),
     }),
   })
-  async sayHello({ name }, context: Context) {
-    const greeting = `Hello, ${name}!`;
-
+  async sayHello({ name }, context: Context, request: Request) {
+    const userAgent = request.get('user-agent') || 'Unknown';
+    const greeting = `Hello, ${name}! Your user agent is: ${userAgent}`;
     const totalSteps = 5;
     for (let i = 0; i < totalSteps; i++) {
-      await new Promise((resolve) => setTimeout(resolve, 500));
+      await new Promise((resolve) => setTimeout(resolve, 100));
 
       // Send a progress update.
       await context.reportProgress({
@@ -116,6 +119,9 @@ export class GreetingTool {
 
 You are done!
 
+> [!TIP]
+> 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).
+
 ## Quick Start for STDIO
 
 The main difference is that you need to provide the `transport` option when importing the module.
@@ -141,7 +147,7 @@ async function bootstrap() {
 void bootstrap();
 ```
 
-Next, you can use the MCP server with an MCP Stdio Client ([see example](playground/clients/stdio-client.ts)), or after building your prject you can use it with the following MCP Client configuration:
+Next, 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:
 
 ```json
 {
@@ -243,32 +249,12 @@ The `McpModule.forRoot()` method accepts an `McpOptions` object to configure the
 | `streamableHttp.sessionIdGenerator` | A function to generate unique session IDs when running in stateful mode. Required if `statelessMode` is `false`.                            | `undefined`                                                          |
 | `streamableHttp.statelessMode` | If `true`, the `STREAMABLE_HTTP` transport operates statelessly (no sessions). If `false`, it operates statefully, requiring a `sessionIdGenerator`. | `true`                                                               |
 
-**Example:**
-
-```typescript
-// app.module.ts
-import { Module } from '@nestjs/common';
-import { McpModule, McpTransportType } from '@rekog/mcp-nest';
-import { GreetingTool } from './greeting.tool';
-import { AuthGuard } from './auth.guard'; // Your custom guard
-import { randomUUID } from 'crypto';
-
-@Module({
-  imports: [
-    McpModule.forRoot({
-      name: 'my-stateful-mcp-server',
-      version: '2.1.0',
-      transport: McpTransportType.STREAMABLE_HTTP, // Only enable Streamable HTTP
-      mcpEndpoint: 'api/mcp', // Custom endpoint
-      guards: [AuthGuard], // Apply authentication
-      streamableHttp: {
-        statelessMode: false, // Enable stateful mode
-        sessionIdGenerator: () => randomUUID(), // Provide a session ID generator
-        enableJsonResponse: false, // Disable JSON responses for non-streaming requests
-      },
-    }),
-  ],
-  providers: [GreetingTool, AuthGuard],
-})
-export class AppModule {}
-```
+<!-- Badges -->
+[ci-url]: https://github.com/rekog-labs/MCP-Nest/actions/workflows/pipeline.yml
+[ci-image]: https://github.com/rekog-labs/MCP-Nest/actions/workflows/pipeline.yml/badge.svg
+[npm-url]: https://www.npmjs.com/package/@rekog/mcp-nest
+[npm-version-image]: https://img.shields.io/npm/v/@rekog/mcp-nest
+[npm-downloads-image]: https://img.shields.io/npm/dm/@rekog/mcp-nest
+[npm-license-image]: https://img.shields.io/npm/l/@rekog/mcp-nest
+[code-coverage-url]: https://codecov.io/gh/rekog-labs/mcp-nest
+[code-coverage-image]: https://codecov.io/gh/rekog-labs/mcp-nest/branch/main/graph/badge.svg