OWASP备忘单服务器

OWASP备忘单MCP服务器

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

服务器使用 快速API 公开一个简单的HTTP API，该API从 OWASP备忘单系列.

先决条件

• Python 3.8或更高版本
• Git（用于在第一次运行时克隆备忘单存储库）

用法

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 部署时使用明确的主机和端口：

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

对于真正的部署，可以考虑使用流程管理器，例如 systemd 或者在反向代理后面运行。

贡献

欢迎拉取请求。测试可以添加到 tests/ 目录使用 pytest.

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