About Symbols MCP
Symbols MCP is an MCP server in the Documentation category: mCP server for Symbols.app — documentation search and framework reference.
Install
claude mcp add symbols-mcp -- npx -y @symbo.ls/mcpnpx -y @symbo.ls/mcpuvx symbols-mcppip install symbols-mcpThis server has no ConduID identity, so agent calls to it are not receipted. Pin the version you install and review the source before granting it credentials.
Tools (6)
detect_environment_[Legacy]_ Caller-supplied flags variant of env classification. Prefer `get_project_context`.
Parameters not published.
get_cli_referenceComplete Symbols CLI (`@symbo.ls/cli`) command reference.
Parameters not published.
get_project_context**CALL FIRST.** Walks up from cwd to find `symbols.json`, returns owner, key, dir, bundler, sharedLibraries, brender, env_type (local/cdn/json_runtime/remote_server), env_evidence, env_guidance, token_present, and a `next_step` hint telling the agent what to do (ask user, log in, or proceed). Replaces the older `detect_environment` for new code.
Parameters not published.
get_project_rulesMandatory ruleset. No arguments → compact CORE bundle (reuse directive + RULES essentials + every STRICT rule + frankability checklist + section index + next-step table, <80K chars — fits every client's tool-output cap). `section="SYNTAX"` (or `COMPONENTS`, `FRANKABILITY`, `RULES` + `part=N`, … 16 sections) fetches one section per call. `full=true` → legacy ~590K one-shot (capless clients only). Call before any code generation task.
Parameters not published.
get_sdk_referenceComplete Symbols SDK (`@symbo.ls/sdk`) API reference.
Parameters not published.
search_symbols_docsKeyword search across all bundled Symbols documentation files.
Parameters not published.
Ask AI
Ask AI about Symbols MCP
Powered by Claude · Grounded in docs
Security checks
- ✓README presentThe repository ships documentation.
5 checks have not been run yet.
README
symbols-mcp
mcp-name: io.github.symbo-ls/symbols-mcp
MCP server for Symbols.app — provides documentation search, code generation, conversion, auditing, project management, publishing/deployment, and CLI/SDK reference tools for AI coding assistants (Cursor, Claude Code, Windsurf, claude.ai, etc.).
No API keys required for documentation tools. Project management tools require a Symbols account (login or API key).
Tools
Documentation & Generation
| Tool | Description |
|---|---|
get_project_rules |
Returns mandatory Symbols.app rules. Call this first before any code generation task. |
search_symbols_docs |
Keyword search across all bundled Symbols documentation files. |
generate_component |
Generate a DOMQL v3 component from a natural language description. |
generate_page |
Generate a full page with routing integration. |
convert_react |
Convert React/JSX code to Symbols DOMQL v3. |
convert_html |
Convert raw HTML/CSS to Symbols DOMQL v3 components. |
convert_to_json |
Convert DOMQL v3 JS source code to platform JSON (mirrors frank's toJSON pipeline). |
audit_component |
Audit component code for v3 compliance — returns violations, warnings, and a score. |
detect_environment |
Detect whether the project is local, CDN, JSON runtime, or remote server. |
get_cli_reference |
Returns the complete Symbols CLI (@symbo.ls/cli) command reference. |
get_sdk_reference |
Returns the complete Symbols SDK (@symbo.ls/sdk) API reference. |
Project Management & Publishing
| Tool | Description |
|---|---|
login |
Log in to Symbols platform — returns a JWT token. |
list_projects |
List the user's projects (names, keys, IDs) to choose from. |
create_project |
Create a new Symbols project on the platform. |
get_project |
Get a project's current data (components, pages, design system, state). |
save_to_project |
Save components/pages/data to a project — creates a new version with change tuples, granular changes, orders, and auto-generated schema entries. |
publish |
Publish a version (make it live). |
push |
Deploy a project to an environment (production, staging, dev). |
End-to-End Flow (from claude.ai or any MCP client)
1. generate_component → JS source code
2. convert_to_json → platform JSON
3. login → get token
4. create_project → (if new project needed)
list_projects → (or pick existing)
5. save_to_project → push JSON to platform (creates version)
6. publish → make version live
7. push → deploy to environment
Resources
Skills (documentation)
| URI | Description |
|---|---|
symbols://skills/rules |
Strict rules for AI agents working in Symbols/DOMQL v3 projects |
symbols://skills/syntax |
Complete DOMQL v3 syntax language reference |
symbols://skills/components |
Component reference with flattened props and onX events |
symbols://skills/project-structure |
Project folder structure and file conventions |
symbols://skills/design-system |
Design system tokens, themes, and configuration |
symbols://skills/design-direction |
Modern UI/UX design direction |
symbols://skills/patterns |
UI patterns, accessibility, and AI optimization |
symbols://skills/migration |
Migration guide (v2→v3, React/Angular/Vue→Symbols) |
symbols://skills/audit |
Full audit, enforcement, and feedback framework |
symbols://skills/design-to-code |
Design-to-code translation guide |
symbols://skills/seo-metadata |
SEO metadata configuration reference |
symbols://skills/ssr-brender |
Server-side rendering with brender (SSR/SSG) |
symbols://skills/cookbook |
Interactive cookbook with 30+ runnable recipes |
symbols://skills/snippets |
Production-ready component snippets |
symbols://skills/default-library |
127+ pre-built components available in all projects |
symbols://skills/default-components |
Complete source code of 130+ default template components |
symbols://skills/learnings |
Framework internals, technical gotchas, deep runtime knowledge |
symbols://skills/running-apps |
4 ways to run Symbols apps (local, CDN, JSON, remote) |
symbols://skills/cli |
Symbols CLI (@symbo.ls/cli) complete command reference |
symbols://skills/sdk |
Symbols SDK (@symbo.ls/sdk) complete API reference |
Reference (inline)
| URI | Description |
|---|---|
symbols://reference/spacing-tokens |
Spacing token table (golden-ratio scale) |
symbols://reference/atom-components |
Built-in atom/primitive components |
symbols://reference/event-handlers |
Event handler signatures and patterns |
Prompts
| Prompt | Description |
|---|---|
symbols_component_prompt |
Generate a component from a description |
symbols_migration_prompt |
Migrate code from React/Angular/Vue |
symbols_project_prompt |
Scaffold a complete project |
symbols_review_prompt |
Review code for v3 compliance |
symbols_convert_html_prompt |
Convert HTML/CSS to DOMQL v3 |
symbols_design_review_prompt |
Visual/design audit against the design system |
Installation
pip install symbols-mcp
Or with uv (no install needed):
uvx symbols-mcp
Or via npm:
npx @symbo.ls/mcp
Configuration
Recommended (auto-updates on every launch)
{
"mcpServers": {
"symbols": {
"command": "uvx",
"args": ["--refresh", "symbols-mcp"]
}
}
}
The --refresh flag checks PyPI for a newer version each time the server starts. Adds ~1-2s to startup but ensures you always have the latest rules and documentation.
Alternative configs
npm (also auto-updates):
{
"mcpServers": {
"symbols": {
"command": "npx",
"args": ["-y", "@symbo.ls/mcp"]
}
}
}
Pinned version (manual updates):
{
"mcpServers": {
"symbols": {
"command": "uvx",
"args": ["symbols-mcp"]
}
}
}
Manual update
# pip
pip install --upgrade symbols-mcp
# uv (clear cache and re-run)
uv cache clean symbols-mcp && uvx symbols-mcp
# npm
npm update -g @symbo.ls/mcp
Transport modes
By default, the server runs over stdio. For SSE transport:
MCP_TRANSPORT=sse MCP_HOST=0.0.0.0 MCP_PORT=8080 uvx symbols-mcp
README copy captured when this server was indexed; it may lag the repository. The original is authoritative.