MCP Guard 使用说明书 (Workspace Guardian Manual)
MCP Guard 是一个标准的 Model Context Protocol (MCP) 静态合规守卫与交互式依赖图谱工具，原生支持 Python, C++, Java, Go, Rust, JavaScript, TypeScript 等多语言软件开发。
🚀 最佳开发流程操作顺序 (Recommended Workflow)
为了获得最佳的软件开发合规与拓扑导航体验，建议您和 AI 智能体按照以下顺序执行指令：
➔ 步骤一：工作空间初始化与自举环境就绪 (Initialize & Bootstrap)
在您的项目工作区根目录下运行初始化指令：
mcp-guard init
- 支持透传构建参数：
mcp-guard init支持直接透传构建参数（如-f/--force,-src/--src,--pivot,--exclude），例如：mcp-guard init -src --exclude third_party --exclude docs
- 自适应指纹识别：系统会自动极速扫描您的项目。如果探测到
package.xml或 ROS 构建关键字，会自适应额外拷出 ROS 专项规则库 (ros_rules.md)，否则只拷贝通用规则。 - 释放软件开发全生命周期规范模板：初始化时会自动在当前工作区的
.agents/templates/目录中释出核心流程骨架文件，引导并强制 AI 智能体规范工作：RESEARCH_REPORT.md(系统调研与分析报告模板)IMPLEMENTATION_PLAN.md(编码方案与实施设计模板)TEST_GUIDE.md(测试自检、通用/ROS 调试打印与一键清理规范)
- 国内极速自举：系统 Python 3.8+ 只承担 bootstrap CLI；初始化阶段会自动安装
uv并在独立 Python 3.11 虚拟环境中安装 MCP 服务。本项目已默认配置中科大及清华大学高速镜像源，实现秒级部署。
➔ 步骤二：集成至开发环境 (Install)
将 MCP 服务器一键注册至您当前使用的 IDE 或 AI 客户端：
# 注册至 Antigravity IDE (推荐)
mcp-guard install ide
# 注册至 Claude Code CLI 终端工具
mcp-guard install claude
# 注册至 VS Code Cline / Roo-Cline 插件
mcp-guard install cline
# 注册至 VS Code Codex 扩展
mcp-guard install codex
➔ 步骤三：构建代码图谱的三种模式 (Build Modes)
扫描当前工作区所有源文件，根据您的项目架构规模选择以下三种模式之一：
- 模式一：扁平全景拓扑模式（适合中小型项目，将所有文件调用画在单张大图里）
mcp-guard build - 模式二：ROS 轴心下钻模式（针对 ROS 结构，自动以
src目录为边界划分并生成多子图网页）mcp-guard build -src
- 模式三：自定义轴心下钻模式（针对多包或自定义多模块项目，将指定目录如
packages、lib等作为划分大节点）mcp-guard build --pivot <目录名>
- 其他构建参数说明：
- 自适应增量：比对文件修改时间
mtime，未修改的文件 1 毫秒跳过，仅解析变化文件。 - 强制全量重建与排除目录：若需忽略缓存强行重新扫描并覆盖图谱或排除特定文件夹，请运行：
mcp-guard build -src -f --exclude third_party
- 自适应增量：比对文件修改时间
➔ 步骤四：渲染交互式图谱 (View)
在系统默认浏览器中打开层级大纲与可视化图谱网络：
mcp-guard view
- 大纲树折叠：左侧提供 📁文件夹 ➔ 文件（含语言原生图标）➔ 类 / 函数 的 IDE 级折叠大纲，点击自动对齐并平滑 focus 聚焦到拓扑图，右侧面板展示入度与出度依赖详情。
- 多层级双击下钻：若您使用了下钻模式（模式二/三），在浏览器中**【双击】**模块大节点，页面即可自动深入下钻到该包内部的精细依赖调用子图网页中。
➔ 步骤五：代码编写与增量强审计 (Audit)
- 静默看守：代码编写过程中，AI 智能体会自动调用 MCP 接口校验您修改的文件，防止引入系统命令注入、空捕获、或缺失中文注释。
- 手动强审计：您可以在终端随时手动对当前的改动执行强制自检审计：
mcp-guard audit
🛠️ CLI 命令行参数速查 (--help)
运行 mcp-guard --help 可以随时获取最新的中文参数速查表：
mcp-guard init：在当前工作区初始化守则库与说明书模板，并构建初始依赖图谱（支持-f/--force,-src/--src,--pivot,--exclude）。mcp-guard build：扫描并更新图谱。支持-src轴模式，支持--pivot <dir>自定义轴模式，支持-f / --force强制全量重构，支持--exclude排除目录。mcp-guard view：在默认浏览器中渲染并打开层级交互式依赖图谱网页（支持双击节点下钻）。mcp-guard audit：手动审计工作区变更文件并提供缺失注释的自愈修复代码。mcp-guard install <target>：一键将本 MCP 服务器注册至对应的客户端（如ide、claude、cline、codex等）。mcp-guard uninstall：一键卸载清理 mcp-guard 在当前工作区内的配置文件、自举虚拟环境，并从所有 IDE 绑定中反注册注销服务。
1 maintainer
Metadata
1 maintainer
Release files for mcp-workspace-guardian 0.6.27
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mcp_workspace_guardian-0.6.27.tar.gz | 108.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mcp_workspace_guardian-0.6.27-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 233.8 kB
Release files / mcp_workspace_guardian-0.6.27.tar.gz
| Download URL | mcp_workspace_guardian-0.6.27.tar.gz |
|---|---|
| Size | 108.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0b8446273a828dea53443855c9b8872f1f95cc2d8da896fdcc7701760e2b31be
|
|
BLAKE2b-256 checksum How to use checksums |
1380d9e9469b36f411a9856ec1b25723a389f151c6b0e164ba76eaede82b1263
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.5
|
Release files / mcp_workspace_guardian-0.6.27-py3-none-any.whl
| Download URL | mcp_workspace_guardian-0.6.27-py3-none-any.whl |
|---|---|
| Size | 125.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
aeba0f350c20013d9b52abb4f754ba816ccf339befe369a4922c0872c06fe610
|
|
BLAKE2b-256 checksum How to use checksums |
f70206a7c0f8bdca8c8fb283b41526f33a9a4f6c036924b6c332ddaba3e12c24
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.5
|
