Skip to main content
Glama
QuantGeekDev

mcp-framework-starter

by QuantGeekDev

mcp-框架-启动器

使用 mcp-framework 构建的模型上下文协议 (MCP) 服务器。

快速入门

# Install dependencies
npm install

# Build the project
npm run build

Related MCP server: MCP Server Boilerplate

项目结构

mcp-framework-starter/
├── src/
│   ├── tools/        # MCP Tools
│   │   └── ExampleTool.ts
│   └── index.ts      # Server entry point
├── package.json
└── tsconfig.json

添加组件

该项目附带一个示例工具,位于src/tools/ExampleTool.ts 。您可以使用 CLI 添加更多工具:

# 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

工具开发

示例工具结构:

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

interface MyToolInput {
  message: string;
}

class MyTool extends MCPTool<MyToolInput> {
  name = "my_tool";
  description = "Describes what your tool does";

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

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

export default MyTool;

发布到 npm

  1. 更新你的 package.json:

    • 确保name唯一并遵循 npm 命名约定

    • 设置适当的version

    • 添加description 、 author 、 license等。

    • 检查bin指向正确的入口文件

  2. 本地构建和测试:

    npm run build
    npm link
    mcp-framework-starter  # Test your CLI locally
  3. 登录 npm(如有必要,请创建帐户):

    npm login
  4. 发布你的包:

    npm publish

发布后,用户可以将其添加到他们的 claude 桌面客户端(见下文)或使用 npx 运行它


## Using with Claude Desktop

### Local Development

Add this configuration to your Claude Desktop config file:

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

```json
{
  "mcpServers": {
    "mcp-framework-starter": {
      "command": "node",
      "args":["/absolute/path/to/mcp-framework-starter/dist/index.js"]
    }
  }
}

发布后

将此配置添加到您的 Claude Desktop 配置文件:

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

{
  "mcpServers": {
    "mcp-framework-starter": {
      "command": "npx",
      "args": ["mcp-framework-starter"]
    }
  }
}

构建和测试

  1. 更改你的工具

  2. 运行npm run build进行编译

  3. 服务器将在启动时自动加载您的工具

了解更多

Related MCP Connectors

Related MCP Servers

  • F
    license
    C
    quality
    D
    maintenance
    A starter template for building Model Context Protocol servers that integrate with AI assistants like Claude and Cursor, providing custom tools, resource providers, and prompt templates.
    2
    12 npm
    -
  • F
    license
    C
    quality
    D
    maintenance
    A starter template for building Model Context Protocol servers that integrate with AI assistants like Claude and Cursor, providing custom tools, resource providers, and prompt templates.
    2
    12 npm
    -
  • A
    license
    Not graded
    quality
    D
    maintenance
    A starter template for creating Model Context Protocol servers that integrate with Claude Desktop and other MCP-compatible clients. Provides a configurable tool system, Docker support, and TypeScript-ready structure for building custom MCP servers.
    12 npm
    MIT
  • F
    license
    B
    quality
    C
    maintenance
    A starter template for building custom MCP servers that can integrate with Claude Desktop, Cursor, and other AI assistants. Provides example tools, TypeScript support, and automated publishing workflows to help developers quickly create their own MCP integrations.
    1
    13 npm
    -