MCP ts-morph Refactoring Tools

🚀 MCP 服务器配置文档

MCP（Multiple Character Programming）是一个用于管理多个游戏角色的框架。本指南将详细指导您完成基于 TypeScript 的 MCP 服务器的配置与运行。

🚀 快速开始

安装依赖

请确保您已安装 Node.js（版本 14 或更高）和 npm。运行以下命令来安装项目所需的依赖：

pnpm install

配置 mcp.json

创建一个 mcp.json 文件，并添加所需的服务器配置。示例如下：

{
  "mcpServers": {
    "mcp-ts-morph": {
      "command": "node",
      "args": ["dist/index.js"],
      "env": {
        "NODE_ENV": "production",
        "PORT": 3000
      }
    }
  }
}

启动服务器

运行以下命令启动 MCP 服务器：

pnpm run start

✨ 主要特性

MCP 框架具备管理多个游戏角色的能力，支持 TypeScript 开发，可通过配置文件灵活设置服务器参数，还能使用环境变量和 CLI 参数进行高级配置。

📦 安装指南

克隆仓库

git clone git@github.com:yourusername/mcp.git
cd mcp

安装依赖

pnpm install

初始化 MCP 服务器

创建 mcp.json 配置文件，并添加计划运行的服务器配置。示例如下：

{
  "mcpServers": {
    "mcp-ts-morph": {
      "command": "node",
      "args": ["src/index.ts"],
      "env": {
        "NODE_ENV": "development",
        "PORT": 3000,
        "DEBUG": true
      }
    }
  }
}

启动开发服务器

pnpm run dev

💻 使用示例

基础用法

以下是启动 MCP 服务器的基本步骤：

# 克隆仓库
git clone git@github.com:yourusername/mcp.git
cd mcp
# 安装依赖
pnpm install
# 启动服务器
pnpm run start

高级用法

环境变量配置

您可以通过 env 字段在 mcp.json 中设置环境变量，或者直接传递 CLI 参数。示例如下：

# 使用默认值
pnpm run start --name mcp-ts-morph

# 自定义端口和环境
pnpm run start --name mcp-ts-morph --port 3001 --env production

以不同用户身份运行

若要以特定用户身份运行 MCP 服务器，可以使用 sudo 命令：

sudo -u username pnpm run start --name mcp-ts-morph

打包和部署

打包

使用 pnpm run build 命令生成生产环境下的构建文件。

pnpm run build

部署到云服务

将打包后的文件上传至您的云服务提供商（如 AWS、Azure 或阿里云），并配置相应的启动脚本。

使用 Docker 部署

创建 Dockerfile

# 基础镜像
FROM node:16

# 设置工作目录
WORKDIR /app

# 安装依赖
COPY package.json pnpm-lock.yaml ./
RUN pnpm install --frozen-lockfile

# 复制源代码
COPY . .

# 启动命令
CMD ["pnpm", "run", "start"]

构建镜像

docker build -t mcp-server .

运行容器

docker run -p 3000:3000 mcp-server

📚 详细文档

示例项目

创建新项目

使用以下命令创建一个新的 MCP 项目：

pnpm create mcp my-project
cd my-project

配置示例

mcp.json 示例配置：

{
  "mcpServers": {
    "web-server": {
      "command": "node",
      "args": ["dist/index.js"],
      "env": {
        "NODE_ENV": "production",
        "PORT": 8080
      }
    },
    "api-gateway": {
      "command": "node",
      "args": ["dist/api.js"],
      "env": {
        "NODE_ENV": "production",
        "PORT": 3001
      }
    }
  }
}

扩展和插件

开发插件

创建自定义插件并将其发布到 npm registry，供其他开发者使用。

使用插件

在 mcp.json 中引用插件：

{
  "plugins": [
    "@example/plugin-name"
  ]
}

教程和示例

官方文档

查阅 MCP 官方文档 获取更多详细信息。

示例仓库

参考 MCP 的 示例项目 学习实际应用。

社区和支持

讨论组

加入 MCP 的官方讨论群，与其他开发者交流经验：

• Discord: https://discord.mcp.dev
• Telegram: https://t.me/mcpchat

提交问题

在 GitHub 仓库中提交 issue 报告 bug 或提出改进建议。

版本历史

v1.0.0 - 初始版本

• 添加基本功能和文档

v2.0.0 - 主要更新

• 引入 TypeScript 支持
• 增强配置选项
• 优化性能和稳定性

🔧 技术细节

MCP 框架基于 TypeScript 开发，使用 Node.js 作为运行环境，通过配置文件 mcp.json 来管理服务器参数。服务器启动时会读取配置文件中的命令、参数和环境变量，以确保服务器按照预期运行。在开发模式下，支持热重载和调试功能，方便开发者快速迭代代码。

📄 许可证

本项目遵循 MIT 协议。更多细节请参阅 LICENSE 文件。