Skip to content

命令列表

gm-mcp 提供了以下命令来帮助您创建和管理MCP项目。

全局命令

gm-mcp --help

显示帮助信息。

bash
gm-mcp --help

输出示例:

Usage: gm-mcp [options] [command]

MCP TypeScript项目脚手架工具

Options:
  -V, --version                  output the version number
  -h, --help                     display help for command

Commands:
  init [options] [project-name]  初始化一个新的MCP TypeScript项目
  help                           显示帮助信息
  version                        显示版本信息
  update                         检查并更新脚手架工具

gm-mcp --version

显示当前安装的版本信息。

bash
gm-mcp --version

输出示例:

1.0.0

项目命令

gm-mcp init [project-name]

初始化一个新的MCP TypeScript项目。

语法

bash
gm-mcp init [project-name] [options]

参数

  • project-name (可选): 项目名称。如果不提供,将提示您输入。

选项

选项简写描述默认值
--template-t选择项目模板basic
--yes-y跳过确认提示,使用默认配置false

可用模板

  • basic: 基础模板(推荐用于学习和开发)
  • advanced: 高级模板(推荐用于生产环境)
  • minimal: 最小模板(推荐用于快速原型)

使用示例

bash
# 交互式创建项目
gm-mcp init my-mcp-project

# 使用指定模板
gm-mcp init my-project --template advanced

# 跳过确认,使用默认配置
gm-mcp init my-project --yes

# 使用最小模板快速创建
gm-mcp init my-project --template minimal --yes

交互式流程

当您运行 gm-mcp init 时,将引导您完成以下步骤:

  1. 输入项目名称(如果未提供)
  2. 选择项目模板
  3. 确认是否安装依赖

gm-mcp help

显示详细的帮助信息。

bash
gm-mcp help

输出示例:

📚 gm-mcp 脚手架工具帮助

可用命令:
  init [project-name]    初始化一个新的MCP TypeScript项目
  help                   显示此帮助信息
  version                显示版本信息
  update                 检查并更新脚手架工具

选项:
  -t, --template <name>  选择项目模板 (basic|advanced|minimal)
  -y, --yes              跳过确认提示,使用默认配置
  -h, --help             显示帮助信息
  -V, --version          显示版本信息

示例:
  gm-mcp init my-mcp-project
  gm-mcp init my-project --template advanced
  gm-mcp init my-project --yes
  gm-mcp --help

模板说明:
  basic     - 基础模板,包含基本的MCP服务器结构
  advanced  - 高级模板,包含更多功能和示例
  minimal   - 最小模板,最简化的MCP服务器

gm-mcp version

显示详细的版本信息。

bash
gm-mcp version

输出示例:

📦 gm-mcp 版本信息

版本: 1.0.0
Node.js: v20.14.0
平台: darwin
架构: arm64

相关信息:
作者: Your Name
许可证: MIT
GitHub: https://github.com/your-username/gm-mcp

gm-mcp update

检查并更新脚手架工具。

bash
gm-mcp update

输出示例:

🔄 检查更新...

✔ 正在检查最新版本...
最新版本: 1.0.0
✅ 您已经安装了最新版本!

📚 更新日志:
查看完整更新日志: https://github.com/your-username/gm-mcp/releases

错误处理

常见错误

项目名称已存在

bash
 目录 "my-project" 已存在

解决方案: 选择不同的项目名称或删除现有目录。

网络连接问题

bash
💡 提示: 确保网络连接正常,或稍后重试

解决方案: 检查网络连接或稍后重试。

权限问题

bash
Error: EACCES: permission denied

解决方案: 使用 sudo 或配置npm使用不同的目录。

环境变量

gm-mcp 支持以下环境变量:

变量名描述默认值
NPM_REGISTRYnpm注册表URLhttps://registry.npmjs.org/
GM_MCP_CACHE_DIR缓存目录~/.gm-mcp/cache

下一步

基于 MIT 许可证发布