使用说明(简要、可操作)
-
项目简介
- Redstack Vault 集成了一个基于 MCP 的后端服务器,负责托管与管理多类资源(Procedures、Commands、Tools、Techniques 等),注册和执行工具,定义并渲染 Prompt 模板,以向 LLM 客户端提供一致的上下文和功能入口。
-
主要功能点
- MCP 核心能力:提供资源读取、工具执行、提示模板获取等接口,统一以 JSON-RPC 形式与客户端通信。
- 资源管理:集中管理攻击过程、工具、命令、标签、子-techniques 等内容,形成可查询的知识图谱。
- 工具注册与执行:支持对外部工具的注册、调用与返回结果。
- Prompt 模板定义与渲染:定义可自定义的提示模板,便于不同交互模式的生成任务。
- 数据结构与流行格式支持:采用 YAML/Markdown 的结构化数据,便于向量化、检索与推理使用。
- 客户端集成:提供 Claude Desktop 的原生集成方案,及 LangChain/LlamaIndex 等无缝接入能力。
- 传输协议与渲染端点:支持标准 JSON-RPC 与 SSE 端点用于语义检索等功能。
-
安装步骤
-
- 克隆仓库并进入项目根目录。
-
- 在服务器端启用环境(Python 3.10+):
- 创建并激活一个虚拟环境
- 安装依赖(如包含 mcp_server.py 及其依赖)
-
- 启动 MCP 服务器:
- 进入 .mcp-server 目录,执行启动脚本(start.sh)或直接运行 mcp_server.py
-
- 连接客户端:
- 将 Claude Desktop 等 MCP 客户端配置为指向服务器(详见下方“服务器配置”描述)
-
-
服务器配置(MCP 客户端所需,JSON 形式描述;用于建立与 MCP 服务器的连接)
- server_name: redstack-vault
- command: python
- args: ["/absolute/path/to/redstack-vault/.mcp-server/mcp_server.py"]
- 说明: 该配置用于 MCP 客户端在启动时自动启动并连接到指定 MCP 服务器入口。请将 absolute_path 替换为服务器实际的文件系统路径。
- 备注: MCP 客户端仅需读取此配置中的 server_name、command 与 args 即可建立与 MCP 服务器的连接,JSON 配置本身不直接输出到终端,仅用于描述连接信息。
-
基本使用方法
- 启动后,MCP 服务器将监听来自客户端的 JSON-RPC 请求(如读取资源、调用工具、获取 Prompt 等)。
- 客户端下发请求后,服务器返回相应的 JSON-RPC 响应。
- 使用 SSE 端点进行语义检索和实时查询扩展。
- 常见操作示例(由客户端发起,服务器返回结果):
- 获取某工具的可用命令
- 查询特定技术对应的 attack chain
- 渲染并获取某个 Prompt 模板
- 服务器会负责会话管理、能力声明及多传输协议支持,确保在高并发场景下的上下文服务稳定性。
-
运行注意
- 确保目录结构与 README 说明一致,.mcp-server 目录包含入口脚本与所需依赖。
- Claude Desktop 集成需要在配置中添加服务器条目并确保 Python 环境可执行。
信息
分类
AI与计算