owasp_cheatsheets_mcp_server

提供 OWASP 备忘单的最小模型上下文协议 (MCP) 兼容服务器。

服务器使用FastAPI公开一个简单的 HTTP API，该 API 返回来自OWASP 备忘单系列的备忘单内容。

先决条件

• Python 3.8 或更高版本

• Git（用于在首次运行时克隆备忘单存储库）

Related MCP server: Excel MCP Server

用法

1. 安装要求：

   pip install -r requirements.txt

2. *（可选）*如果您已经拥有备忘单的本地副本，请设置CHEATSHEETS_DIR ：

   export CHEATSHEETS_DIR=/path/to/CheatSheetSeries/cheatsheets

3. 使用uvicorn运行服务器：

   uvicorn server.app:app --reload

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

端点

• GET /health – 基本健康检查。

• GET /cheatsheets – 列出可用的备忘单文件。

• GET /cheatsheets/{name} – 检索特定的备忘单。

• GET /search?q=term – 在备忘单中搜索某个术语并返回匹配的文件名。

生产运行中

部署时使用带有明确主机和端口的uvicorn ：

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

贡献

欢迎提交 Pull 请求。可以使用pytest将测试添加到tests/目录下。

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