MCP-Bridge 项目使用教程

MCP-Bridge 项目使用教程

MCP-Bridge A middleware to provide an openAI compatible endpoint that can call MCP tools 项目地址: https://gitcode.com/gh_mirrors/mc/MCP-Bridge

1. 项目目录结构及介绍

MCP-Bridge 项目是一个开源中间件，旨在提供一个兼容 OpenAI API 的端点，以便调用 MCP 工具。以下是项目的目录结构及其介绍：

MCP-Bridge/
├── .github/              # GitHub 工作流和配置文件
├── .vscode/              # VSCode 项目配置
├── assets/               # 静态资源目录
├── charts/               # 图表相关文件
├── docs/                 # 项目文档
├── mcp_bridge/           # 项目主要代码目录
│   ├── __init__.py
│   ├── main.py           # 项目启动和主要逻辑文件
│   └── ...
├── .gitignore            # Git 忽略文件
├── Dockerfile            # Docker 构建文件
├── LICENSE               # 项目许可证文件
├── README.md             # 项目说明文件
├── compose.yml           # Docker Compose 配置文件
├── docker-bake.hcl        # Docker bake 配置文件
├── mypy.ini              # mypy 配置文件
├── pyproject.toml        # Python 项目配置文件
└── uv.lock               # uvicorn 锁文件

2. 项目的启动文件介绍

项目的启动文件是 mcp_bridge/main.py。该文件负责初始化应用，设置服务器配置，并启动服务。以下是一个简化的启动文件内容：

# main.py
from fastapi import FastAPI
from mcp_bridge import uvicorn  # 导入 uvicorn 用于启动 ASGI 应用

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "MCP-Bridge is running"}

if __name__ == "__main__":
    uvicorn.run(app, host="0.0.0.0", port=8000)

3. 项目的配置文件介绍

项目的配置文件是 config.json。这个文件包含了应用运行所需的各种配置信息，如服务器地址、端口、API 密钥、MCP 服务器配置等。以下是一个配置文件的示例：

{
    "inference_server": {
        "base_url": "http://example.com/v1",
        "api_key": "None"
    },
    "mcp_servers": {
        "fetch": {
            "command": "uvx",
            "args": ["mcp-server-fetch"]
        }
    },
    "network": {
        "host": "0.0.0.0",
        "port": 9090
    },
    "logging": {
        "log_level": "DEBUG"
    },
    "api_key": "your-secure-api-key-here"
}

在运行项目之前，需要确保 config.json 文件存在并且配置正确。可以通过编辑文件或者通过环境变量来设置配置信息。

MCP-Bridge A middleware to provide an openAI compatible endpoint that can call MCP tools 项目地址: https://gitcode.com/gh_mirrors/mc/MCP-Bridge