首页
/ MCP-Hub 项目启动与配置教程

MCP-Hub 项目启动与配置教程

2025-05-19 13:21:50作者:温玫谨Lighthearted

1. 项目的目录结构及介绍

MCP-Hub 是一个用于管理 Model Context Protocol (MCP) 服务器的集中式管理器,它支持动态服务器管理和监控。以下是项目的目录结构及各部分的简要介绍:

mcp-hub/
├── .github/                      # GitHub 工作流和配置文件
├── .vscode/                      # Visual Studio Code 项目配置
├── examples/                     # 示例文件和配置
├── scripts/                      # 脚本文件,用于构建和测试等
├── src/                          # 源代码目录
├── tests/                        # 测试代码目录
├── .gitignore                    # Git 忽略文件列表
├── CHANGELOG.md                  # 更改日志
├── CODE_OF_CONDUCT.md            # 行为准则
├── CONTRIBUTING.md               # 贡献指南
├── LICENSE.md                    # 许可证文件
├── README.md                     # 项目自述文件
├──SECURITY.md                    # 安全策略
├── TROUBLESHOOTING.md            # 故障排除指南
├── flake.lock                    # Nix 包管理器锁文件
├── flake.nix                     # Nix 包管理器配置文件
├── mcp-servers.json              # MCP 服务器配置文件
├── nodemon.json                  # nodemon 配置文件
├── package-lock.json             # npm 包锁文件
├── package.json                  # npm 包配置文件
└── vitest.config.js              # Vitest 测试框架配置文件
  • .github/: 包含用于持续集成和自动化测试的 GitHub Actions 工作流。
  • .vscode/: 包含 Visual Studio Code 的项目配置,如代码片段和设置。
  • examples/: 包含项目使用示例和示例配置文件。
  • scripts/: 包含构建、测试和其他自动化任务的脚本。
  • src/: 包含项目的主要源代码。
  • tests/: 包含项目的单元测试和集成测试代码。
  • .gitignore: 指定 Git 应该忽略的文件和目录。
  • CHANGELOG.md: 记录项目的更新、修改和改进历史。
  • CODE_OF_CONDUCT.md: 阐明项目的行为准则和社区规范。
  • CONTRIBUTING.md: 提供贡献代码的指南和流程。
  • LICENSE.md: 项目使用的许可证信息。
  • README.md: 项目介绍、功能和使用说明。
  • SECURITY.md: 安全相关的政策和报告问题的指南。
  • TROUBLESHOOTING.md: 提供解决常见问题的步骤和建议。

2. 项目的启动文件介绍

项目的启动主要是通过 package.json 文件中的脚本实现的。以下是 package.json 中定义的一些关键启动脚本:

{
  "scripts": {
    "start": "mcp-hub --port 3000 --config path/to/config.json",
    "watch": "mcp-hub --port 3000 --config path/to/config.json --watch",
    // 其他脚本...
  }
}
  • "start": 用于启动 MCP-Hub 服务器,指定端口和配置文件路径。
  • "watch": 与 "start" 类似,但会监视配置文件的变化,并重新加载服务器。

可以使用以下命令启动项目:

npm start

或者监视配置文件变化:

npm run watch

3. 项目的配置文件介绍

MCP-Hub 使用一个 JSON 格式的配置文件来定义管理的服务器。配置文件通常命名为 config.json,位于项目的根目录。以下是配置文件的一个基本示例:

{
  "mcpServers": {
    "filesystem": {
      "command": "npx",
      "args": ["arg1", "$ACCESS_TOKEN"],
      "env": {
        "ACCESS_TOKEN": null,
        "OP_KEY": "$: cmd:op read read op://example/secret",
        "AUTH_HEADER": "Bearer ${ACCESS_TOKEN}",
        "SECRET": "confidential"
      }
    },
    "remote-server": {
      "url": "https://api.example.com/mcp",
      "headers": {
        "Authorization": "Bearer ${EXAMPLE_API_KEY}"
      }
    }
  }
}

在这个配置文件中:

  • "mcpServers": 是一个对象,包含所有 MCP 服务器的配置。
  • "filesystem": 是一个 STDIO 服务器的配置,包括启动命令、参数和环境变量。
  • "remote-server": 是一个远程服务器的配置,包括服务器 URL 和请求头。

配置文件可以同时包含 STDIO 服务器和远程服务器的配置,但不能在一个服务器配置中混合使用两者的字段。

登录后查看全文
热门项目推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
23
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
226
2.28 K
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
flutter_flutterflutter_flutter
暂无简介
Dart
527
116
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
989
586
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
351
1.43 K
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
61
17
GLM-4.6GLM-4.6
GLM-4.6在GLM-4.5基础上全面升级:200K超长上下文窗口支持复杂任务,代码性能大幅提升,前端页面生成更优。推理能力增强且支持工具调用,智能体表现更出色,写作风格更贴合人类偏好。八项公开基准测试显示其全面超越GLM-4.5,比肩DeepSeek-V3.1-Terminus等国内外领先模型。【此简介由AI生成】
Jinja
47
0
giteagitea
喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
17
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
JavaScript
214
288