Symbols MCP

符号mcp

mcp名称：io.github.symbo-ls/symbols-mcp

MCP服务器 符号.app --为AI编码助手（Cursor、Claude code、Windsurf、Claude.AI等）提供文档搜索、代码生成、转换、审计、项目管理、发布/部署和CLI/SDK参考工具。

瞄准现代 smbls 栈-平面元素API，基于信号的反应性，声明性 fetch: (@symbo.ls/fetch)，多语种翻译(@symbo.ls/polyglot)，头盔元数据(@symbo.ls/helmet)SPA路由 el.router(...)，主题通过 @symbo.ls/scratch，以及SSR通过 @symbo.ls/brender.

文档工具不需要API密钥。项目管理工具需要Symbols帐户（登录或API密钥）。

______________________________________________________________________

工具

上下文——从这里开始

发电和转换

审计

对于文件系统范围的审计，该软件包附带了一个CLI： npx -y @symbo.ls/mcp symbols-audit （默认情况下严格，发现后退出1）。它在引擎盖下运行 frank-audit audit --strict --审计核心现在是 @symbo.ls/frank-audit，基于AST的引擎，拥有规范的59规则注册表、处方生成和验证或回滚修复程序。

lib/audit.js 保留为向后兼容垫片，委托坦率审核（子流程CLI或 /audit-content HTTP端点 FRANK_AUDIT_URL 已设置）。传统的编程API对于非CLI使用者保持可调用状态（ @symbo.ls/cli，MCP HTTP worker，网络/边缘客户端）：

const {
  auditContent,         // audit one component string (delegates to frank-audit)
  auditFiles,           // audit a list of {path, content}
  auditDirectory,       // walk a symbols/ dir via `frank-audit audit `
  mergeFindings,        // preserve status across runs
  summarize,            // breakdown by severity / category / origin
} = require('@symbo.ls/mcp/lib/audit')

与旧正则表达式输出相比，结果漂移是意料之中的，也是正确的——frank审计以更高的准确性检测到更多的问题。字段名称保持不变（文件、行、规则、严重性、类别、代码段、suggested_fix）。要检查规则注册表，请直接查询frank audit： npx frank-audit explain .

项目管理与出版

端到端流（来自任何MCP客户端）

1. get_project_context  → resolve owner/key/env/auth state from cwd's symbols.json
2. generate_component   → JS source code
3. audit_component      → inline check (saves a roundtrip if violations exist)
4. convert_to_json      → platform JSON
5. login                → only if token_present was false in step 1
6. create_project       → (if new project needed)
   list_projects        → (or pick existing)
7. save_to_project      → push JSON to platform (creates version)
8. publish              → make version live
7. push                → deploy to environment

资源

技能（文件）

参考（内联）

提示

______________________________________________________________________

快速入门

两个命令和一行配置——适用于每个主要的MCP客户端。

1.安装

选择您拥有的运行时：

uvx symbols-mcp           # uv  — recommended, zero install
pip install symbols-mcp   # pip — global binary
npx -y @symbo.ls/mcp      # npm — Node-friendly wrapper

2.配置编辑器

标准MCP配置代码段（适用于 克劳德代码, 克劳德桌面版, 光标, 帆板运动, 克莱恩, 继续, 泽德, 鹅, Gemini CLI --将其包装成编辑器期望的任何形状）：

{
  "mcpServers": {
    "symbols-mcp": {
      "type": "stdio",
      "command": "uvx",
      "args": ["--refresh", "symbols-mcp"]
    }
  }
}

--refresh 每次启动时从PyPI中提取最新数据（~1-2s启动税——对于固定/离线运行，请将其丢弃）。

3.验证

在编辑聊天中，询问助理：

使用 symbols-mcp 叫 get_project_rules，然后总结现代堆栈规则。

如果这返回了一个很长的规则集，那么你就设置好了。尝试 audit_component 在一个故意破坏的片段上确认规则62（禁止用于图标规则的内联SVG）的触发。

______________________________________________________________________

自动引导Symbols项目——不再有“使用符号mcp”提醒

曾经 symbols-mcp 如果已在编辑器中配置，请删除项目级规则文件，以便每个编辑器在每次聊天时自动加载框架规则：

# from your Symbols project root
npx -y @symbo.ls/mcp init-rules

写 CLAUDE.md, .cursor/rules/symbols.md, .windsurfrules, .clinerules，以及 AGENTS.md --每个都是针对其编辑器定制的，都指向符号mcp工具(get_project_context, get_project_rules, generate_component, audit_component等等）。等同；通过 --force 覆盖或 --only=cursor,claude 范围。

结合MCP服务器 instructions 字段（由每个MCP感知编辑器在连接时自动加载——Claude Code、Cursor、Windsurf、Cline、Continue、Roo、Zed、Goose、Gemini CLI、Antigravity、Cody），这意味着您永远不必提醒代理“使用符号MCP”——工作流在第一次交互时启动。

Claude Code:强制挂钩（默认安装）

项目级规则文件（CLAUDE.md、AGENTS.md等）是尽力而为的——长上下文会稀释它们，代理可能会漂移。对于克劳德代码， init-rules 还安装了一个由线束直接执行的挂钩层：

已安装的文件：

.claude/settings.json                       # wires the three hooks
.claude/hooks/symbols-mcp-require.sh        # PreToolUse  — block edit until rules loaded
.claude/hooks/symbols-mcp-reminder.sh       # UserPromptSubmit — inject directive
.claude/hooks/symbols-mcp-audit.sh          # PostToolUse — frank-audit + FA-rule check

跳过挂钩： npx -y @symbo.ls/mcp init-rules --no-hooks. 在运行时禁用单个挂钩： SYMBOLS_MCP_REQUIRE_RULES=0, SYMBOLS_MCP_REMINDER=0, SYMBOLS_MCP_POST_AUDIT=0.

挂钩需要 bash 和 jq 上 PATH （已经是macOS/大多数Linux发行版的标准配置）。 frank-audit 通过以下方式调用 npx -y --no-install @symbo.ls/frank-audit --如果未安装，内联模式检查仍将运行。

看 设置.md→ 自举 用于分层模型和验证步骤。

______________________________________________________________________

那...呢 /symbols-audit?

这 /symbols-audit 斜线命令是 仅限克劳德代码，但底层功能在 每个MCP感知编辑器 --Cursor、Windsurf、Cline、Continue、Roo、Zed、Goose、Gemini CLI、Antigravity（谷歌）、Cody、Claude.ai web和任何自定义MCP客户端。

三种模式：

1. 自然语言 （零设置）--只需说 _“使用Symbols mcp对此项目运行完整的Symbols审核。”_ 代理人打电话来 get_project_context → audit_project （剧本）→ bin/symbols-audit CLI → 使用迭代修复 audit_component.
2. 自定义命令 --注册光标规则、继续自定义命令、Windsurf工作流等，以实现一键奇偶校验。模板在 设置.md.
3. 纯贝壳 — npx -y @symbo.ls/mcp symbols-audit ./symbols 可以在任何终端上工作，不需要编辑器。默认情况下严格，根据发现退出1。

______________________________________________________________________

完整设置指南

看 设置.md 用于：

• 根据编辑器配置： Claude Code·Claude Desktop·Claude.ai（网络）·Cursor·Windsurf·Zed·Cline·Continue·Roo·Cody·Gemini CLI·Goose·Antigravity·通用客户端
• 地方发展： 克隆仓库，从源代码运行， .mcp.json 模板
• 使用 /symbols-audit &非Claude代码编辑器中的其他工具： 自然语言、每个编辑器的自定义命令、shell回退、直接获取捆绑的venv
• 运输方式： stdio（默认）和SSE（用于claude.ai网络/远程客户端）
• 审核CLI： 独立 bin/symbols-audit 用于CI/预提交
• 更新 和 故障排除 （PATH问题、过时版本、缺少工具）