Mcpserver

🚀 My MCP Server

A Model Context Protocol (MCP) server built with mcp-framework.

🚀 Quick Start

# Install dependencies
npm install

# Build the project
npm run build

📦 Project Structure

my-mcp-server/
├── src/
│   ├── tools/        # MCP tools
│   │   └── ExampleTool.ts
│   └── index.ts      # Server entry file
├── package.json
└── tsconfig.json

✨ Adding Components

The project comes with an example tool at src/tools/ExampleTool.ts. You can use the CLI to add more tools:

# Add a new tool
mcp add tool my-tool

# Example tools you might create:
mcp add tool data-processor
mcp add tool api-client
mcp add tool file-handler

💻 Tool Development

Example tool structure:

import { MCPTool } from "mcp-framework";
import { z } from "zod";

interface MyToolInput {
  message: string;
}

class MyTool extends MCPTool<MyToolInput> {
  name = "my_tool";
  description = "Describe the functionality of your tool";

  schema = {
    message: {
      type: z.string(),
      description: "Description of this input parameter",
    },
  };

  async execute(input: MyToolInput) {
    // Your tool logic goes here
    return `Processed: ${input.message}`;
  }
}

export default MyTool;

🚀 Publishing to npm

1. Update package.json:

   • Ensure the name is unique and follows npm naming conventions.
   • Set an appropriate version.
   • Add information such as description, author, and license.
   • Check that bin points to the correct entry file.

2. Build and test locally:

   npm run build
   npm link
   my-mcp-server  # Test your CLI locally
   

3. Log in to npm (create an account if necessary):

   npm login
   

4. Publish your package:

   npm publish
   

After publishing, users can add it to their Claude Desktop client (read the instructions below) or run it using npx.

🔗 Integrating with Claude Desktop

Local Development

Add the following to the Claude Desktop configuration file:

MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "my-mcp-server": {
      "command": "node",
      "args": ["/absolute/path/to/my-mcp-server/dist/index.js"]
    }
  }
}

After Publishing

Add the following to the Claude Desktop configuration file:

MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "my-mcp-server": {
      "command": "npx",
      "args": ["my-mcp-server"]
    }
  }
}

🔧 Building and Testing

1. Modify your tool code.
2. Run npm run build to compile.
3. The server will automatically load your tools after startup.