______________________________________________________________________
AIDEFEND MCP/REST API服务
   
本地检索服务 AIDEFEND框架.
该存储库安全地解析框架的JavaScript策略，构建本地LanceDB知识库，并通过以下方式公开结果：
- 用于应用程序和自动化的REST API
- 用于Claude Desktop等人工智能助手的MCP服务器
此存储库是 不 框架本身。它是框架之上的服务层。
所得
- AIDEFEND内容的局部语义搜索
- REST API和MCP从同一索引知识库访问
- 默认情况下，从上游GitHub存储库自动同步
- 为在两个repos上工作的贡献者提供可选的本地框架覆盖
- 多语言嵌入搜索
Xenova/multilingual-e5-base - GitHub Actions中的自动测试和Bandit安全扫描
运作原理
- 从GitHub同步AIDEFEND战术文件。
- 使用Node.js AST解析器解析JavaScript文件。该服务不执行上游框架代码。
- 将战术扩展为技术、子技术和策略。
- 生成嵌入并将文档存储在LanceDB中。
- 通过REST或MCP提供索引数据。
需求
- Python 3.9到3.13
- Node.js 18+
- Git
- 大约2到3 GB的可用磁盘空间用于依赖关系、嵌入模型和本地数据库
普通用户会这样做 不 需要配置任何个人本地路径。默认设置从GitHub同步。
快速开始
1.克隆存储库
git clone https://github.com/edward-playground/aidefend-mcp.git
cd aidefend-mcp2.选择安装路径
| 用例 | 推荐命令 |
|---|---|
| 克劳德桌面MCP | python scripts/install.py |
| 克劳德代码MCP | python scripts/install.py --client code |
| 仅限REST API | python scripts/install.py --no-mcp |
| 手动设置 | 遵循 安装.md |
3.建立当地知识库
python __main__.py --resync第一个同步下载框架，嵌入模型，并创建本地数据库。在干净的机器上等待几分钟。
4.运行服务
REST API：
python __main__.pyMCP服务器：
python __main__.py --mcp健康检查：
curl http://127.0.0.1:8000/health从新克隆手动设置
如果你想要一个干净、明确的安装路径，而不是助手脚本：
python -m venv .venv激活虚拟环境。
Windows PowerShell：
.venv\Scripts\Activate.ps1macOS/Linux：
source .venv/bin/activate安装依赖项：
python -m pip install --upgrade pip
python -m pip install -r requirements.txt
npm ci创建本地配置：
macOS/Linux：
cp .env.example .envWindows PowerShell：
Copy-Item .env.example .env然后运行：
python __main__.py --resync
python __main__.py可选本地框架覆盖
默认情况下，服务从GitHub同步。如果您正在开发此仓库以及本地结账 aidefense-framework，您可以将同步指向本地源：
LOCAL_FRAMEWORK_PATH=/path/to/aidefense-framework这是可选的，对于普通开源用户来说应该保持未设置状态。
常用命令
# Rebuild the local database from the configured source
python __main__.py --resync
# Run the REST API
python __main__.py
# Run the MCP server
python __main__.py --mcp
# Run tests
python -m pytest -q
# Run static security scan
python -m bandit -q -r app码头工人
docker-compose up -d在外部绑定时，需要进行身份验证。看 docs/CONFIGURATION.md.
文档
- 安装： 安装.md
- 配置： docs/CONFIGURATION.md
- 高级配置： docs/ADVANCED_CONFIGURATION.md
- 工具参考： docs/TOOLS.md
- 安全注意事项： 安全.md
- 变更日志： 更改日志.md
存储库注释
data/、本地缓存、覆盖率输出，以及.env被git忽略，在存储库中不是必需的。- CI运行
pytest和bandit自动处理推送和拉取请求。 - 截至2026年4月14日，该服务已根据更新的AIDEFEND框架结构进行了验证。
许可证
MIT。看 许可证.