Paragon MCP Server
Provides structured access to component documentation (props, events, code examples, CSS design tokens) for the Open edX Paragon design system, enabling AI assistants to write Paragon-based UI code.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Paragon MCP Server what props does the Button component have?"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Paragon MCP Server
MCP server for the Open edX Paragon design system (v23.x). Gives AI assistants structured access to component documentation — props, events, code examples, and CSS design tokens — so they can write Paragon-based UI code without guessing.
Installation
The quickest way to use this server is via npx (no clone needed):
claude mcp add paragon -- npx -y @romkask/paragon-mcp-serverOr add it manually to your MCP config (~/.claude/settings.json or project .claude/settings.local.json):
{
"mcpServers": {
"paragon": {
"command": "npx",
"args": ["-y", "@romkask/paragon-mcp-server"]
}
}
}Related MCP server: ds-pilot
Available Tools
Tool | Description |
| List all 63 Paragon components with categories, status, and counts |
| Get full details for a component or subcomponent (description, props, events, subcomponents) |
| Get all props with types and descriptions |
| Get all callback events (onClose, onToggle, etc.) |
| List available code examples for a component |
| Get the full JSX code for a specific example |
| Get CSS custom properties / design tokens |
Subcomponent Lookup
All 73 subcomponents (e.g., CardGrid, AlertHeading, FormControl, TableRow) are automatically resolved to their parent component. Querying get_component("CardGrid") returns the full Card component info with a note indicating the subcomponent match.
Data Coverage
63 components (Button, Alert, Card, DataTable, Form, Modal, etc.)
73 subcomponents with automatic parent resolution
410 props with types and descriptions
69 events/callbacks
295 live code examples
443 CSS design token variables
Development
git clone https://github.com/RomkaSk/paragon-mcp-server.git
cd paragon-mcp-server
npm install
npm run build # generates data + bundles with tsup
npm start # run server
npm run dev # dev mode with tsx
npm test # run tests (348 tests covering all components & subcomponents)License
MIT
Available Tools
7 toolsget_componentGet Paragon ComponentARead-onlyIdempotent
Get detailed component info: description, status, props, events, examples, and CSS variables.
Inputs: component (required).
get_component_eventsGet Component EventsARead-onlyIdempotent
Get all callback events (onClose, onClick, etc.) for a component.
Inputs: component (required).
get_component_propsGet Component PropsARead-onlyIdempotent
Get all props for a component with names, types, and descriptions.
Inputs: component (required).
get_components_variablesGet Component CSS VariablesARead-onlyIdempotent
Get CSS custom properties (design tokens) for a component. Filter by category.
Inputs: component (required), category.
get_exampleGet Component ExampleARead-onlyIdempotent
Get full JSX code for a specific example. Search by ID or title (partial match).
Inputs: component (required), title, example_id.
list_componentsList Paragon ComponentsARead-onlyIdempotent
List all Paragon components with categories and status. Optionally filter by category.
Inputs: category.
list_examplesList Component ExamplesARead-onlyIdempotent
List example IDs and titles for a component. Use get_example for full code.
Inputs: component (required).
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 7 tools
get_component aggregates props, events, examples, and CSS variables, making the separate tools like get_component_props and get_component_events redundant and ambiguous. An agent may struggle to decide whether to use the general or specific tool, though the list/detail distinction for examples is clear.
Most tools follow a consistent verb_noun pattern using get_ and list_. The only inconsistency is get_components_variables using plural 'components' while others use singular 'component'. Overall, the naming is predictable and readable.
Seven tools is well within the ideal range for a component documentation server. Each tool addresses a legitimate aspect of component exploration, and the count feels appropriately scoped without being bloated.
The server provides a complete surface for exploring Paragon components: listing components, getting detailed info, and accessing props, events, CSS variables, and examples. No obvious gaps exist for the intended purpose of discovering component APIs.
Maintenance
Related MCP Connectors
MCP server that lets AI assistants use all OneSchema features exposed via the public API.
MCP server for querying Forkast documentation
Token-free MCP server for structured RevoGrid Core, Pro, and Enterprise knowledge retrieval.
Nifty's MCP server — exposes tasks, projects, messages, and files as tools for AI agents.
Related MCP Servers
- AlicenseAqualityCmaintenanceMCP server that exposes the @bunge/ds-components design system catalog, allowing AI assistants to list, search, and retrieve component details including inputs, outputs, usage examples, and import instructions.4MIT
- AlicenseNot gradedqualityDmaintenanceMCP server that exposes your design system components and tokens to AI agents, preventing duplicate component creation and hardcoded token values.4 npm9MIT
- AlicenseNot gradedqualityDmaintenanceA standalone MCP server that provides AI assistants with comprehensive access to BrowserStack's design system components, enabling component search, detailed prop analysis, and usage examples from Storybook.MIT
- AlicenseNot gradedqualityDmaintenanceAn MCP server that gives AI assistants structured access to a design system's tokens, components, guidelines, and patterns, enabling them to read, lint, and author design system data.1MIT