使用说明
MCP服务器符号
MCP(模型上下文协议)服务器,将Symbols/DOMQL v3 AI助手功能暴露给任何MCP兼容平台-- 光标, 克劳德代码, 帆板运动以及更多。
特性
工具
| 工具 | 说明 |
|---|---|
generate_component |
从自然语言生成Symbols/DOMQL v3组件 |
generate_page |
生成具有路由支持的完整页面 |
generate_project |
构建一个完整的多文件Symbols项目 |
convert_to_symbols |
将React/Angular/Vue/HTML转换为Symbols/DOMQL v3 |
search_symbols_docs |
搜索符号文档(矢量或本地) |
explain_symbols_concept |
用例子解释任何符号概念 |
review_symbols_code |
审查v3合规性和最佳实践的代码 |
create_design_system |
生成设计系统文件(颜色、间距、主题、图标) |
资源
| 资源URI | 描述 |
|---|---|
symbols://skills/domql-v3-reference |
完整的DOMQL v3语法参考 |
symbols://skills/project-structure |
项目文件夹结构约定 |
symbols://skills/design-direction |
现代UI/UX设计方向 |
symbols://skills/migration-guide |
React/Angular/Vue→ 符号迁移 |
symbols://skills/v2-to-v3-migration |
DOMQL v2→ v3更改 |
symbols://skills/quickstart |
CLI设置和快速入门 |
symbols://reference/spacing-tokens |
间距标记参考表 |
symbols://reference/atom-components |
内置基本组件 |
symbols://reference/event-handlers |
事件处理程序引用 |
提示
| 提示 | 描述 |
|---|---|
symbols_component_prompt |
组件生成模板 |
symbols_migration_prompt |
框架迁移模板 |
symbols_project_prompt |
项目脚手架模板 |
symbols_review_prompt |
代码审查模板 |
安装
快速启动(不需要API密钥!)
- 克隆存储库:
git clone https://github.com/baronsilver/symbols-mcp-server.git
cd symbols-mcp-server
- 安装依赖项:
pip install uv
uv sync
npm i @symbo.ls/cli -g
smbls create your-project
重要提示:目前,请在创建后删除项目文件夹中的docs文件夹
- 配置:
cp .env.example .env
# Edit .env and add both:
# - SYMBOLS_MCP_URL (contact maintainer for public server URL)
# - LLM_MODEL=google/gemini-3-flash-preview
平台集成
克劳德代码
claude mcp add symbols-mcp -- uv run --directory C:\repos\symbols-mcp-server symbols-mcp
或手动编辑 ~/UserName/.claude.json:
{
"mcpServers": {
"symbols-mcp": {
"command": "python",
"args": [
"-m",
"uv",
"run",
"--directory",
"C:\\repos\\symbols-mcp-server",
"symbols-mcp"
]
}
}
}
光标
添加到光标MCP设置(.cursor/mcp.json 在项目或全局设置中):
{
"mcpServers": {
"symbols-mcp": {
"command": "python",
"args": [
"-m",
"uv",
"run",
"--directory",
"C:\\repos\\symbols-mcp-server",
"symbols-mcp"
]
}
}
}
帆板运动
增添 ~/.codeium/windsurf/mcp_config.json:
{
"mcpServers": {
"symbols-mcp": {
"command": "python",
"args": [
"-m",
"uv",
"run",
"--directory",
"C:\\repos\\symbols-mcp-server",
"symbols-mcp"
]
}
}
}
发展
更新MCP设置后重新启动平台。加载后,它应该自动运行MCP。让你的AI用MCP进行快速测试,看看它是否正常工作。
环境变量
| 变量 | 必填 | 默认 | 描述 |
|---|---|---|---|
OPENROUTER_API_KEY |
是 | - | OpenRouter的API密钥(支持AI生成) |
SUPABASE_URL |
否 | -- | 支持矢量搜索的项目URL |
SUPABASE_KEY |
否 | -- | 支持服务角色键 |
LLM_MODEL |
没有 | openai/gpt-4.1-mini |
通过OpenRouter使用的AI模型 |
SYMBOLS_SKILLS_DIR |
没有 | ./symbols_mcp/skills |
技能标记文件的路径 |
建筑
symbols-mcp-server/
├── pyproject.toml # Project config and dependencies
├── .env.example # Environment variable template
├── README.md # This file
└── symbols_mcp/
├── __init__.py
├── server.py # MCP server with tools, resources, prompts
└── skills/ # Bundled Symbols knowledge base
├── CLAUDE.md # DOMQL v3 complete reference
├── SYMBOLS_LOCAL_INSTRUCTIONS.md # Project structure rules
├── DESIGN_DIRECTION.md # UI/UX design direction
├── MIGRATE_TO_SYMBOLS.md # Framework migration guide
├── DOMQL_v2-v3_MIGRATION.md # v2→v3 changes
└── QUICKSTART.md # CLI quickstart
服务器在启动时读取技能文件,并将其用作所有AI驱动工具的上下文。
配置Supabase后 search_symbols_docs 该工具还可以查询矢量数据库
以获取其他文档匹配。