Merge pull request #5 from Braffolk/dev

NPM info

.github/workflows/npm-publish.yml

@@ -0,0 +1,32 @@
+name: NPM Publish
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: npm run test:ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Publish to NPM
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.npmrc

@@ -0,0 +1,2 @@
+registry=https://registry.npmjs.org/
+always-auth=true

README.md

@@ -7,8 +7,9 @@
 [Features](#features) •
 [AI Agent Integration](#ai-agent-integration) •
 [Installation](#installation) •
-[Usage](#usage) •
-[Architecture](#architecture)
+[Usage](#usage)
+
+[![npm version](https://badge.fury.io/js/%40modelcontextprotocol%2Fsummarization-functions.svg)](https://www.npmjs.com/package/@modelcontextprotocol/summarization-functions)
 
 </div>
 
@@ -18,6 +19,12 @@
 
 A powerful MCP server that provides intelligent summarization capabilities through a clean, extensible architecture. Built with modern TypeScript and designed for seamless integration with AI workflows.
 
+## Installation
+
+```bash
+npm install @modelcontextprotocol/summarization-functions
+```
+
 ## AI Agent Integration
 
 This MCP server was primarily developed to enhance the performance and reliability of AI agents like Roo Cline and Cline. It addresses a critical challenge in AI agent operations: context window management.
@@ -98,12 +105,6 @@ There is NO NEED to process perfect or complete output. Summarized content is AL
 - **AI Agent Context Optimization**
   Prevent context window overflow and improve AI agent performance through intelligent summarization
 
-## Installation
-
-```bash
-npm install
-```
-
 ## Configuration
 
 The server supports multiple AI providers through environment variables:
@@ -182,9 +183,9 @@ Execute and summarize command output.
 {
   // Required
   command: string,    // Command to execute
+  cwd: string,       // Working directory for command execution
 
   // Optional
-  cwd?: string,       // Working directory for command execution
   hint?: string,      // Focus area: "security_analysis" | "api_surface" | "error_handling" | "dependencies" | "type_definitions"
   output_format?: string  // Format: "text" | "json" | "markdown" | "outline" (default: "text")
 }
@@ -195,7 +196,8 @@ Summarize file contents.
 ```typescript
 {
   // Required
-  paths: string[],    // Array of file paths to summarize
+  paths: string[],    // Array of file paths to summarize (relative to cwd)
+  cwd: string,       // Working directory for resolving file paths
 
   // Optional
   hint?: string,      // Focus area: "security_analysis" | "api_surface" | "error_handling" | "dependencies" | "type_definitions"
@@ -208,10 +210,11 @@ Get directory structure overview.
 ```typescript
 {
   // Required
-  path: string,       // Directory path to summarize
+  path: string,       // Directory path to summarize (relative to cwd)
+  cwd: string,       // Working directory for resolving directory path
 
   // Optional
-  recursive?: boolean,  // Whether to include subdirectories
+  recursive?: boolean,  // Whether to include subdirectories. Safe for deep directories
   hint?: string,       // Focus area: "security_analysis" | "api_surface" | "error_handling" | "dependencies" | "type_definitions"
   output_format?: string   // Format: "text" | "json" | "markdown" | "outline" (default: "text")
 }
@@ -240,18 +243,6 @@ Retrieve the full content for a given summary ID.
 }
 ```
 
-## Architecture
-
-Built with clean architecture principles and modern TypeScript features:
-
-```
-src/
-├── models      # AI model implementations
-├── services    # Core business logic
-├── server      # MCP server handling
-└── types       # Shared type definitions
-```
-
 ## License
 
 MIT

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "MCP-summarization-functions",
+  "name": "mcp-summarization-functions",
   "version": "0.1.0",
   "description": "Provides summarised output from various actions that could otherwise eat up tokens and cause crashes",
   "type": "module",
@@ -31,5 +31,22 @@
     "jest": "^29.7.0",
     "ts-jest": "^29.2.5",
     "typescript": "^5.7.2"
-  }
+  },
+  "files": [
+    "build/**/*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Braffolk/MCP-summarization-functions.git"
+  },
+  "keywords": [
+    "mcp",
+    "summarization",
+    "model-context-protocol"
+  ],
+  "author": "Remi Sebastian Kits",
+  "license": "MIT"
 }

src/server/mcp-server.ts

@@ -210,7 +210,7 @@ export class McpServer {
               },
               recursive: {
                 type: 'boolean',
-                description: 'Whether to include subdirectories',
+                description: 'Whether to include subdirectories, safe for large directories',
               },
               ...formatParameters
             },