Skip to main content

A workspace guardian MCP server with an easy installer CLI.

Project description

MCP Guard 使用说明书 (Workspace Guardian Manual)

MCP Guard 是一个标准的 Model Context Protocol (MCP) 静态合规守卫与交互式依赖图谱工具,原生支持 Python, C++, Java, Go, Rust, JavaScript, TypeScript 等多语言软件开发。


🚀 最佳开发流程操作顺序 (Recommended Workflow)

为了获得最佳的软件开发合规与拓扑导航体验,建议您和 AI 智能体按照以下顺序执行指令:

➔ 步骤一:初始化工作空间 (Initialize)

在您的项目工作区根目录下运行初始化指令:

mcp-guard init
  • 自适应指纹识别:系统会自动极速扫描您的项目。如果探测到 package.xml 或 ROS 构建关键字,会自适应额外拷出 ROS 专项规则库 (ros_rules.md),否则只拷贝通用规则。

➔ 步骤二:安装集成注册 (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

➔ 步骤三:构建代码图谱 (Build)

扫描当前工作区所有源文件,构建函数、类之间的跨文件调用图谱:

mcp-guard build
  • 自适应增量扫描:比对文件物理修改时间 mtime,未修改的文件 1 毫秒跳过,仅解析修改文件,速度极快。
  • 安全阻断防护:如果节点数发生骤减,系统会自动拉闸阻断,防止坏数据覆盖了历史健康的图谱。若需强行全量重构,可追加参数运行:
    mcp-guard build --force
    

➔ 步骤四:渲染交互式图谱 (View)

在系统默认浏览器中打开层级大纲与可视化图谱网络:

mcp-guard view
  • 大纲树折叠:左侧提供 📁文件夹 ➔ 文件(含语言原生图标)➔ C 类 / ƒ 函数 的 IDE 级折叠大纲,点击自动对齐并平滑 focus 聚焦到拓扑图,右侧面板展示入度与出度依赖详情。
  • 目录拓扑聚焦:点击目录旁的 🎯 按钮,主图谱自动过滤仅显示该目录内的节点与调用关系,支持跨目录调用边保留。
  • 智能节点唤醒:即使节点被「隐藏无调用符号」过滤,主动点击大纲中的符号后仍可在图谱中临时显示并聚焦该节点。

➔ 步骤五:代码编写与增量强审计 (Audit)

  • 静默看守:代码编写过程中,AI 智能体会自动调用 MCP 接口校验您修改的文件,防止引入系统命令注入、空捕获、或缺失中文注释。
  • 手动强审计:您可以在终端随时手动对当前的改动执行强制自检审计:
    mcp-guard audit
    

🛠️ CLI 命令行参数速查 (--help)

运行 mcp-guard --help 可以随时获取最新的中文参数速查表:

  • mcp-guard init:在当前工作区初始化助手守则、ROS及通用规则库、以及使用说明书文件。
  • mcp-guard build:扫描工作区源码并增量更新依赖图谱。支持 -f / --force 参数强制全量覆盖更新。
  • mcp-guard view:在默认浏览器中渲染并打开层级交互式依赖图谱网页。
  • mcp-guard audit:手动审计工作区变更文件并提供缺失注释的自愈修复代码。
  • mcp-guard install <target>:一键将本 MCP 服务器注册至对应的客户端。

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_workspace_guardian-0.2.2.tar.gz (52.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_workspace_guardian-0.2.2-py3-none-any.whl (53.7 kB view details)

Uploaded Python 3

File details

Details for the file mcp_workspace_guardian-0.2.2.tar.gz.

File metadata

  • Download URL: mcp_workspace_guardian-0.2.2.tar.gz
  • Upload date:
  • Size: 52.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.7

File hashes

Hashes for mcp_workspace_guardian-0.2.2.tar.gz
Algorithm Hash digest
SHA256 c41114b30ce1c22afcc0b29c237deab76d956068ced7453277bc80d297c05ca1
MD5 7ab943fd140db61192addac6c9ee2379
BLAKE2b-256 2e57ca4df1bdc1502bc5a8fc88a715b8849ba2dce843d6145e22aa8ddade2617

See more details on using hashes here.

File details

Details for the file mcp_workspace_guardian-0.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_workspace_guardian-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 380e31aded08f6b2dcc3b9069348d4ef4509749b668aa375b6cf08b765ec6af7
MD5 c53d1faabdcb1631cd469f343544a1c3
BLAKE2b-256 6f04a7ecdc934ee9416a3cc4ee08709c35d043bc9ea0449ad0cd27c899e3fd01

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page