@myatkyawthu/mcp-connect 0.2.0 → 0.2.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 myat-kyaw-thu
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2024 myat-kyaw-thu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -1,170 +1,170 @@
-# mcp-connect
-
-> Dead simple MCP (Model Context Protocol) server for exposing your app functions to AI agents
-
-[![npm version](https://badge.fury.io/js/mcp-connect.svg)](https://www.npmjs.com/package/mcp-connect)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-
-## 🚀 Claude Desktop Setup (5 Minutes)
-
-### Step 1: Install mcp-connect
-
-```bash
-npm install -g @myatkyawthu/mcp-connect
-```
-### Step 2: Create mcp.config.js
-
-### Step 2: Create Your MCP Server
-
-```bash
-# Navigate to your project directory
-cd your-project
-
-# Generate sample config
-mcp-connect init
-```
-
-This creates `mcp.config.js` with example tools:
-
-```javascript
-import { defineMCP } from "@myatkyawthu/mcp-connect";
-
-export default defineMCP({
-  name: "My MCP App",
-  version: "1.0.0",
-  tools: [
-    ["hello", async ({ name = "World" }) => `Hello ${name}!`],
-    ["echo", async ({ message }) => `Echo: ${message}`]
-  ]
-});
-```
-### Step 3: Test Locally
-
-### Step 3: Configure Claude Desktop
-
-Open Claude Desktop config file:
-- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
-- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
-
-Add your MCP server:
-
-```json
-{
-  "mcpServers": {
-    "my-app": {
-      "command": "mcp-connect",
-      "args": ["C:/full/path/to/your/mcp.config.js"]
-    }
-  }
-}
-```
-
-**Important**: Use the full absolute path to your `mcp.config.js` file.
-
-### Step 4: Start & Test
-
-1. **Restart Claude Desktop** completely
-2. **Test connection**: Ask Claude *"What tools do you have available?"*
-3. **Use your tools**: Try *"Hello there!"* or *"Echo this message"*
-
-✅ **Done!** Your functions are now available to Claude Desktop.
-
----
-
-## 📖 Tool Definition Guide
-
-### Simple Format (Recommended)
-
-```javascript
-// Just name and function
-["toolName", async (args) => "result"]
-```
-## 🔧 CLI Usage
-
-### Advanced Format (With Validation)
-
-```javascript
-{
-  name: "toolName",
-  description: "What this tool does",
-  schema: {
-    type: "object",
-    properties: {
-      param: { type: "string", description: "Parameter description" }
-    },
-    required: ["param"]
-  },
-  handler: async ({ param }) => `Result: ${param}`
-}
-```
-
-## 🛠 Development Commands
-
-```bash
-# Start with auto-reload during development
-npm run dev
-
-# Start server with specific config file
-mcp-connect /path/to/your/mcp.config.js
-
-# Format code
-npm run format
-
-# Lint code
-npm run lint
-```
-
-## 🔧 Troubleshooting
-
-### Config File Not Found
-```bash
-# Create sample config
-mcp-connect init
-```
-
-### Claude Desktop Not Connecting
-1. Check config file path is absolute
-2. Restart Claude Desktop completely
-3. Check Claude Desktop logs for errors
-
-### Tool Not Working
-1. Verify tool syntax in `mcp.config.js`
-2. Check server logs for errors
-3. Test with simple tools first
-
-## 📋 Examples
-
-### File Operations
-```javascript
-["readFile", async ({ path }) => {
-  const fs = await import('fs/promises');
-  return await fs.readFile(path, 'utf8');
-}]
-```
-
-### API Calls
-```javascript
-["getWeather", async ({ city }) => {
-  const response = await fetch(`https://api.weather.com/${city}`);
-  return await response.json();
-}]
-```
-
-### Database Queries
-```javascript
-["getUser", async ({ id }) => {
-  // Your database logic here
-  return { id, name: "John Doe", email: "john@example.com" };
-}]
-```
-
-## 🌐 Other MCP Clients
-
-Claude Desktop setup is covered above. Tutorials for other MCP clients coming soon:
-- VS Code extensions
-- Custom applications
-- Other AI platforms
-
-## 📄 License
-
+# mcp-connect
+
+> Dead simple MCP (Model Context Protocol) server for exposing your app functions to AI agents
+
+[![npm version](https://badge.fury.io/js/mcp-connect.svg)](https://www.npmjs.com/package/mcp-connect)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## 🚀 Claude Desktop Setup (5 Minutes)
+
+### Step 1: Install mcp-connect
+
+```bash
+npm install -g @myatkyawthu/mcp-connect
+```
+### Step 2: Create mcp.config.js
+
+### Step 2: Create Your MCP Server
+
+```bash
+# Navigate to your project directory
+cd your-project
+
+# Generate sample config
+mcp-connect init
+```
+
+This creates `mcp.config.js` with example tools:
+
+```javascript
+import { defineMCP } from "@myatkyawthu/mcp-connect";
+
+export default defineMCP({
+  name: "My MCP App",
+  version: "1.0.0",
+  tools: [
+    ["hello", async ({ name = "World" }) => `Hello ${name}!`],
+    ["echo", async ({ message }) => `Echo: ${message}`]
+  ]
+});
+```
+### Step 3: Test Locally
+
+### Step 3: Configure Claude Desktop
+
+Open Claude Desktop config file:
+- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
+- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
+
+Add your MCP server:
+
+```json
+{
+  "mcpServers": {
+    "my-app": {
+      "command": "mcp-connect",
+      "args": ["C:/full/path/to/your/mcp.config.js"]
+    }
+  }
+}
+```
+
+**Important**: Use the full absolute path to your `mcp.config.js` file.
+
+### Step 4: Start & Test
+
+1. **Restart Claude Desktop** completely
+2. **Test connection**: Ask Claude *"What tools do you have available?"*
+3. **Use your tools**: Try *"Hello there!"* or *"Echo this message"*
+
+✅ **Done!** Your functions are now available to Claude Desktop.
+
+---
+
+## 📖 Tool Definition Guide
+
+### Simple Format (Recommended)
+
+```javascript
+// Just name and function
+["toolName", async (args) => "result"]
+```
+## 🔧 CLI Usage
+
+### Advanced Format (With Validation)
+
+```javascript
+{
+  name: "toolName",
+  description: "What this tool does",
+  schema: {
+    type: "object",
+    properties: {
+      param: { type: "string", description: "Parameter description" }
+    },
+    required: ["param"]
+  },
+  handler: async ({ param }) => `Result: ${param}`
+}
+```
+
+## 🛠 Development Commands
+
+```bash
+# Start with auto-reload during development
+npm run dev
+
+# Start server with specific config file
+mcp-connect /path/to/your/mcp.config.js
+
+# Format code
+npm run format
+
+# Lint code
+npm run lint
+```
+
+## 🔧 Troubleshooting
+
+### Config File Not Found
+```bash
+# Create sample config
+mcp-connect init
+```
+
+### Claude Desktop Not Connecting
+1. Check config file path is absolute
+2. Restart Claude Desktop completely
+3. Check Claude Desktop logs for errors
+
+### Tool Not Working
+1. Verify tool syntax in `mcp.config.js`
+2. Check server logs for errors
+3. Test with simple tools first
+
+## 📋 Examples
+
+### File Operations
+```javascript
+["readFile", async ({ path }) => {
+  const fs = await import('fs/promises');
+  return await fs.readFile(path, 'utf8');
+}]
+```
+
+### API Calls
+```javascript
+["getWeather", async ({ city }) => {
+  const response = await fetch(`https://api.weather.com/${city}`);
+  return await response.json();
+}]
+```
+
+### Database Queries
+```javascript
+["getUser", async ({ id }) => {
+  // Your database logic here
+  return { id, name: "John Doe", email: "john@example.com" };
+}]
+```
+
+## 🌐 Other MCP Clients
+
+Claude Desktop setup is covered above. Tutorials for other MCP clients coming soon:
+- VS Code extensions
+- Custom applications
+- Other AI platforms
+
+## 📄 License
+
 MIT © [myat-kyaw-thu](https://github.com/myat-kyaw-thu)

package/package.json

@@ -1,63 +1,63 @@
-{
-  "name": "@myatkyawthu/mcp-connect",
-  "version": "0.2.0",
-  "description": "Dead simple MCP (Model Context Protocol) server for exposing your app functions to AI agents",
-  "type": "module",
-  "main": "./src/index.js",
-  "module": "./src/index.js",
-  "exports": {
-    ".": {
-      "import": "./src/index.js",
-      "require": "./src/index.js"
-    }
-  },
-  "bin": {
-    "mcp-connect": "./src/cli.js"
-  },
-  "files": [
-    "src",
-    "README.md",
-    "LICENSE"
-  ],
-  "scripts": {
-    "start": "node src/cli.js",
-    "dev": "nodemon src/cli.js",
-    "test": "node --test",
-    "test:unit": "node --test tests/unit",
-    "test:integration": "node --test tests/integration",
-    "lint": "eslint src/",
-    "format": "prettier --write src/"
-  },
-  "keywords": [
-    "mcp",
-    "model-context-protocol",
-    "ai",
-    "agents",
-    "tools",
-    "claude",
-    "gpt",
-    "javascript",
-    "nodejs"
-  ],
-  "author": "myat-kyaw-thu",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/myat-kyaw-thu/MCP_Indigration_Package-NPM.git"
-  },
-  "bugs": {
-    "url": "https://github.com/myat-kyaw-thu/MCP_Indigration_Package-NPM/issues"
-  },
-  "homepage": "https://github.com/myat-kyaw-thu/MCP_Indigration_Package-NPM#readme",
-  "engines": {
-    "node": ">=18.0.0"
-  },
-  "dependencies": {
-    "@modelcontextprotocol/sdk": "^0.5.0"
-  },
-  "devDependencies": {
-    "nodemon": "^3.0.0",
-    "eslint": "^8.0.0",
-    "prettier": "^3.0.0"
-  }
+{
+  "name": "@myatkyawthu/mcp-connect",
+  "version": "0.2.1",
+  "description": "Dead simple MCP (Model Context Protocol) server for exposing your app functions to AI agents",
+  "type": "module",
+  "main": "./src/index.js",
+  "module": "./src/index.js",
+  "exports": {
+    ".": {
+      "import": "./src/index.js",
+      "require": "./src/index.js"
+    }
+  },
+  "bin": {
+    "mcp-connect": "src/cli.js"
+  },
+  "files": [
+    "src",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "start": "node src/cli.js",
+    "dev": "nodemon src/cli.js",
+    "test": "node --test",
+    "test:unit": "node --test tests/unit",
+    "test:integration": "node --test tests/integration",
+    "lint": "eslint src/",
+    "format": "prettier --write src/"
+  },
+  "keywords": [
+    "mcp",
+    "model-context-protocol",
+    "ai",
+    "agents",
+    "tools",
+    "claude",
+    "gpt",
+    "javascript",
+    "nodejs"
+  ],
+  "author": "myat-kyaw-thu",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/myat-kyaw-thu/MCP_Indigration_Package-NPM.git"
+  },
+  "bugs": {
+    "url": "https://github.com/myat-kyaw-thu/MCP_Indigration_Package-NPM/issues"
+  },
+  "homepage": "https://github.com/myat-kyaw-thu/MCP_Indigration_Package-NPM#readme",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^0.5.0"
+  },
+  "devDependencies": {
+    "nodemon": "^3.0.0",
+    "eslint": "^8.0.0",
+    "prettier": "^3.0.0"
+  }
 }

package/src/cli.js

@@ -5,9 +5,6 @@ import { resolve } from 'path';
 import { defineMCP } from './defineMCP.js';
 import { MCPConnectServer } from './server/mcpServer.js';
 
-/**
- * Handle init command - create sample config file
- */
 async function handleInitCommand() {
   const configPath = resolve(process.cwd(), 'mcp.config.js');
 
@@ -68,13 +65,8 @@ export default defineMCP({
   }
 }
 
-/**
- * CLI entry point for mcp-connect
- * Uses MCP SDK with STDIO transport or Express.js for HTTP transport
- */
 async function main() {
   try {
-    // Handle init command
     if (process.argv[2] === 'init') {
       await handleInitCommand();
       return;
@@ -82,13 +74,10 @@ async function main() {
 
     console.error('Starting MCP-Connect CLI...');
 
-    // Check if config file path is provided as argument
     const configArg = process.argv[2];
-    /** @type {string|null} */
     let configPath = null;
 
     if (configArg) {
-      // Config file path provided as argument
       const fullPath = resolve(configArg);
       if (existsSync(fullPath)) {
         configPath = fullPath;
@@ -97,7 +86,6 @@ async function main() {
         process.exit(1);
       }
     } else {
-      // Look for config file in current directory (prioritize .js and .mjs)
       const configPaths = ['mcp.config.js', 'mcp.config.mjs', 'mcp.config.ts'];
 
       for (const path of configPaths) {
@@ -134,7 +122,6 @@ export default defineMCP({
 
     let configModule;
     try {
-      // Handle TypeScript config files
       if (configPath.endsWith('.ts')) {
         console.error('TypeScript config detected. For Node.js compatibility:');
         console.error('1. Rename mcp.config.ts to mcp.config.js and convert to JavaScript');
@@ -157,7 +144,6 @@ export default defineMCP({
         process.exit(1);
       }
 
-      // Import config file using Node.js ES modules
       const fileUrl = configPath.startsWith('/')
         ? `file://${configPath}`
         : `file:///${configPath.replace(/\\/g, '/')}`;
@@ -190,7 +176,6 @@ export default defineMCP({
       process.exit(1);
     }
 
-    // Validate config using defineMCP (in case user didn't use it)
     let validatedConfig;
     try {
       validatedConfig = typeof config === 'function' ? config : defineMCP(config);
@@ -199,11 +184,9 @@ export default defineMCP({
       process.exit(1);
     }
 
-    // Create and start MCP server
     const server = new MCPConnectServer(validatedConfig);
     await server.start();
 
-    // Handle graceful shutdown
     process.on('SIGINT', async () => {
       console.error('Shutting down...');
       try {
@@ -229,8 +212,6 @@ export default defineMCP({
   }
 }
 
-// Run CLI if this file is executed directly
-// Multiple checks to ensure main() runs when CLI is executed
 const isMainModule =
   process.argv[1] &&
   (import.meta.url === `file://${process.argv[1]}` ||

package/src/defineMCP.js

@@ -1,21 +1,7 @@
 import { formatValidationErrors, validateConfig } from './utils/configValidation.js';
 import { logger } from './utils/logger.js';
 
-/**
- * Define MCP configuration with tools and server settings
- * This is the main user-facing API that converts simple tool definitions
- * into MCP-compliant format with comprehensive validation
- *
- * @param {Object} config - Configuration object
- * @param {string} config.name - Server name
- * @param {string} config.version - Server version
- * @param {string} [config.description] - Server description
- * @param {import('./types/mcp.js').ToolDefinition[]} config.tools - Tool definitions
- * @returns {import('./types/mcp.js').MCPConfig} MCP configuration object
- * @throws {Error} If configuration is invalid
- */
 export function defineMCP(config) {
-  // Comprehensive configuration validation
   const validationResult = validateConfig(config);
 
   if (!validationResult.isValid) {
@@ -24,7 +10,6 @@ export function defineMCP(config) {
     throw new Error(`Invalid MCP configuration:\n${errorMessage}`);
   }
 
-  // Log warnings if any
   if (validationResult.warnings.length > 0) {
     const warningMessage = formatValidationErrors({
       isValid: true,
@@ -34,11 +19,8 @@ export function defineMCP(config) {
     logger.warn('Configuration warnings', warningMessage);
   }
 
-  // Convert validated tool definitions to MCP format
-  /** @type {import('./types/mcp.js').MCPTool[]} */
   const mcpTools = config.tools.map((tool) => {
     if (Array.isArray(tool)) {
-      // Handle [name, function] format
       const [name, handler] = tool;
       return {
         name: name.trim(),
@@ -51,7 +33,6 @@ export function defineMCP(config) {
         handler,
       };
     } else {
-      // Handle object format
       const { name, handler, description, schema } = tool;
       return {
         name: name.trim(),
@@ -66,7 +47,6 @@ export function defineMCP(config) {
     }
   });
 
-  // Return MCP-compliant config
   return {
     name: config.name,
     version: config.version,