README
🚀 Secure Chain MCP Server
Secure Chain MCP Server 是一个 MCP 服务器,它提供了在 Secure Chain 环境中检查软件供应链状态的工具。
🚀 快速开始
开发要求
- 使用 Docker 来部署工具。
- 使用 Docker Compose 进行容器编排。
- 建议使用诸如 MongoDB Compass 之类的图形用户界面(GUI)。
- 当容器运行时,用于可视化从数据构建的图的 Neo4J 浏览器界面位于 localhost:7474。
- Python 3.13 或更高版本。
使用 Docker 部署
1. 克隆仓库
从官方 GitHub 仓库克隆项目:
git clone https://github.com/securechaindev/securechain-mcp-server.git
cd securechain-mcp-server
2. 配置环境变量
从 .env.example 文件创建一个 .env.local 文件,并将其放置在根目录中。
获取 API 密钥
- 了解如何获取 GitHub API 密钥。
- 使用你自己的密钥修改 JSON Web Token (JWT) 密钥和算法。你可以使用命令 openssl rand -base64 32 生成自己的密钥。
3. 创建 Docker 网络
确保你已经创建了 securechain Docker 网络。如果没有,请使用以下命令创建:
docker network create securechain
4. 数据库容器
对于图和漏洞信息,你需要从 Zenodo 下载压缩的 数据转储。解压转储文件后,在根文件夹内运行以下命令:
docker compose up --build
容器化的数据库也将自动进行数据填充。
5. 启动应用程序
从项目根目录运行以下命令:
docker compose -f dev/docker-compose.yml up --build
6. 在 Secure Chain 本地部署中创建用户
访问 此处 创建一个用户,例如:
{
"email": "mcp-bot@example.com",
"password": "supersecre3T*"
}
7. 使用 VSCode 配置 MCP
在 .vscode/ 文件夹内添加 mcp.json 文件,内容如下:
{
"servers": {
"Secure Chain": {
"type": "http",
"url": "http://localhost:8005/mcp",
"headers": {
"X-Auth-Email": "mcp-bot@example.com",
"X-Auth-Pass": "supersecre3T*"
}
}
}
}
然后启动 MCP 服务器,并开始使用它,例如与 Copilot 一起使用。
Python 环境
项目使用 Python 3.13,依赖项列在 requirements.txt 中。
设置开发环境
- 创建虚拟环境:
python3.13 -m venv depex-env
- 激活虚拟环境:
source depex-env/bin/activate
- 安装依赖项:
pip install -r requirements.txt
🤝 贡献代码
欢迎提交拉取请求!对于重大更改,请先打开一个问题,讨论你想要做出的更改。
Scan to join WeChat group