owasp_cheatsheets_mcp_server

一个提供OWASP Cheat Sheets的最小模型上下文协议（MCP）兼容服务器。

该服务器使用FastAPI 暴露了一个简单的HTTP API，用于从OWASP Cheat Sheet Series 返回备忘单的内容。

前提条件

• Python 3.8 或更新版本
• Git（首次运行时用于克隆备忘单仓库）

使用方法

1. 安装依赖： bash pip install -r requirements.txt

2. (可选) 如果您已经有一个本地备忘单副本，请设置 CHEATSHEETS_DIR： bash export CHEATSHEETS_DIR=/path/to/CheatSheetSeries/cheatsheets

3. 使用 uvicorn 运行服务器： bash uvicorn server.app:app --reload

4. 如果未设置 CHEATSHEETS_DIR，服务器将在首次启动时克隆备忘单仓库（需要网络访问）。

端点

• GET /health – 基本健康检查。
• GET /cheatsheets – 列出可用的备忘单文件。
• GET /cheatsheets/{name} – 获取特定的备忘单。
• GET /search?q=term – 在备忘单中搜索某个术语并返回匹配的文件名。

生产环境运行

在部署时使用 uvicorn 并明确指定主机和端口：

bash uvicorn server.app:app --host 0.0.0.0 --port 8000

对于实际部署，可以考虑使用如 systemd 的进程管理器或在反向代理后运行。

贡献

欢迎提交拉取请求。可以在 tests/ 目录下使用 pytest 添加测试。

此实现是一个简化的MCP服务器示例，可能并未涵盖整个规范。

来源

• 来源：github
• 链接：https://github.com/santosomar/owasp_cheatsheets_mcp_server