MCP Gateway 开源项目使用教程

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

MCP Gateway 的目录结构如下：

mcp-gateway/
├── docs/                   # 项目文档
├── mcp_gateway/            # 核心代码目录
├── tests/                  # 测试代码目录
├── .gitignore              # Git 忽略文件
├── LICENSE                 # 项目许可证文件
├── MANIFEST.in             # 打包文件列表
├── README.md               # 项目说明文件
├── pyproject.toml          # Python 项目配置文件
└── requirements.txt        # 项目依赖文件

• docs/: 包含项目的文档，通常包括项目说明、使用教程等。
• mcp_gateway/: 包含项目的主要代码，包括模块和类。
• tests/: 包含项目的测试代码，用于确保代码的质量和稳定性。
• .gitignore: 包含Git应该忽略的文件和目录列表，例如编译生成的文件和私有配置文件。
• LICENSE: 包含项目的许可证信息，通常为MIT或其他开源许可证。
• MANIFEST.in: 包含打包项目时需要包含的文件列表。
• README.md: 包含项目的简要描述、安装和使用说明。
• pyproject.toml: 包含项目的Python构建系统配置。
• requirements.txt: 包含项目运行所需的外部Python库。

2. 项目的启动文件介绍

项目的启动文件为 mcp-gateway/mcp_gateway/server.py，它是MCP Gateway服务的主入口点。以下是启动文件的主要内容：

# 导入必要的模块
from mcp_gateway import app

# 设置服务运行的端口
app.run(host='0.0.0.0', port=5000)

要启动项目，你可以在项目根目录下运行以下命令：

python mcp-gateway/mcp_gateway/server.py

这将启动一个监听5000端口的Web服务。

3. 项目的配置文件介绍

项目的配置文件为 ~/.cursor/mcp.json 或 ~/.cursor/claude_desktop_config.json，这是一个JSON格式的文件，用于配置MCP Gateway的行为。以下是配置文件的主要内容：

{
    "mcpServers": {
        "mcp-gateway": {
            "command": "mcp-gateway",
            "args": ["--mcp-json-path", "~/.cursor/mcp.json", "--enable-guardrails", "basic"],
            "servers": {
                "filesystem": {
                    "command": "npx",
                    "args": ["-y", "@modelcontextprotocol/server-filesystem", "."]
                }
            }
        }
    }
}

配置文件包含以下部分：

• mcpServers: 包含MCP服务器的配置。
• command: 指定启动MCP Gateway的命令。
• args: 指定启动MCP Gateway时使用的参数，例如配置文件路径和启动的守护插件。
• servers: 包含其他MCP服务器的配置，例如文件系统服务。

要使用配置文件，确保将配置路径正确指定给 --mcp-json-path 参数。