MCP Plugin

MCP 插件

这是一个 MCP 插件项目，提供了用于快速创建 MCP 工具的脚手架。可以用于 mcp_server_exe 的插件开发。

这是一个 MCP 插件项目，提供了用于快速创建 MCP 工具的脚手架。可用于开发 mcp_server_exe 插件。

功能 | 功能

中文	中文
提供命令行工具，快速创建 MCP 插件项目	提供命令行工具，快速创建 MCP 插件项目
内置默认模板，包含基础工具示例	内置默认模板，包含基础工具示例
支持 TypeScript 开发环境	支持 TypeScript 开发环境
集成测试框架（Jest）	集成测试框架（Jest）

安装 | 安装

全局安装（推荐）| 全局安装（推荐）

npm install -g mcp-plugin

本地安装 | 本地安装

npm install mcp-plugin

使用方法 | 使用方法

创建新项目 | 创建新项目

# 创建新项目 | Create new project
mcp-plugin init

# 使用指定模板创建项目 | Create project with specific template
mcp-plugin init -t template-name

创建项目过程中会提示输入：| 创建项目过程中会提示输入：

中文	中文
项目名称	项目名称
项目描述	项目描述
作者信息	作者信息

与 MCP 服务集成 | 与 MCP 服务集成

中文：构建完成后，可以通过以下方式启动 MCP 服务并加载你的插件：

中文：构建完成后，可以通过以下方式启动 MCP 服务并加载你的插件：

mcp_server-win-x64.exe --mcp-js ./dist/index.js

通过表单创建工具 | 通过表单创建工具

中文	中文
你可以通过可视化表单快速生成自定义工具代码：	你可以通过可视化表单快速生成自定义工具代码：

mcp-plugin create

• 启动后会自动打开浏览器，访问本地工具生成器页面（默认端口 3366）。| 启动后会自动打开浏览器，访问本地工具生成器页面（默认端口 3366）。
• 在左侧填写工具名称、描述和参数字段，支持多种类型（字符串、数字、布尔、日期、枚举等）。| 在左侧填写工具名称、描述和参数字段，支持多种类型（字符串、数字、布尔、日期、枚举等）。
• 可添加多个参数字段，并设置是否为可选。| 可添加多个参数字段，并设置是否为可选。
• 中间区域实时预览生成的 TypeScript 工具代码和参数示例。| 中间区域实时预览生成的 TypeScript 工具代码和参数示例。
• 右侧可选择常用模板快速开始。| 右侧可选择常用模板快速开始。
• 点击“复制代码”以复制生成的代码，然后将其粘贴到项目的 src/tools 目录中使用。

默认模板工具示例 | 默认模板工具示例

1. test-echo

中文	中文
功能：回显输入的消息	功能：回显输入的消息
参数：message (string)	参数：message (string)

2. get-current-time

中文	中文
功能：获取当前时间	功能：获取当前时间
参数：无	参数：无

3. math-add

中文	中文
功能：计算两个数字的和	功能：计算两个数字的和
参数：	参数：

• a (number)：第一个数字 | - a (number)：第一个数字
• b (number)：第二个数字 | - b (number)：第二个数字

自定义开发 | 自定义开发

你可以在 src 目录下修改或添加新的工具。每个工具需要实现：

你可以在 src 目录下修改或添加新的工具。每个工具需要实现：

中文	中文
工具名称	工具名称
工具描述	工具描述
参数 schema（使用 zod 定义）	参数 schema（使用 zod 定义）
处理函数	处理函数

示例 | 示例：

server.tool(
  'tool-name',           // 工具名称 | Tool name
  'Tool description',    // 工具描述 | Tool description
  {
    param: z.string()    // 参数定义 | Parameter definition
  },
  async (args) => {      // 处理函数 | Handler function
    // 实现逻辑 | Implementation logic
    return {
      content: [
        {
          type: 'text',
          text: 'result'
        }
      ]
    }
  }
)

项目开发 | 项目开发

中文	中文

1. 进入项目目录：| 1. 进入项目目录：

cd your-project-name

2. 安装依赖：| 2. 安装依赖：

npm install

3. 开发模式：| 3. 开发模式：

npm run dev

4. 构建项目：| 4. 构建项目：

npm run build

5. 运行测试：| 5. 运行测试：

npm test

许可证 | 许可证

Apache