@tylertech/forge-mcp
v1.1.0
Published
MCP server for Tyler Forge™ web component library documentation
Readme
Tyler Forge™ MCP Server
Access Tyler Forge™ web component documentation directly in AI clients. Discover components, generate framework-specific code, validate APIs, and use design tokens correctly.
Features
- Version-aware: Detects your installed Tyler Forge version and provides matching documentation
- Forge Blocks: Pre-built UI patterns showing components working together in context (forms, tables, layouts, dashboards)
- Usage Examples: Isolated code snippets for individual component structure and API
- Component Validation: Verify generated code against actual component APIs
- Design Tokens: Access colors, spacing, typography, and other design tokens
- Framework Guides: Setup instructions for Angular, React, Vue, Svelte, and Lit
Setup
Claude Code Plugin (Recommended)
The plugin bundles the MCP server with a /forge-design skill for expert UI guidance.
Install:
/plugin marketplace add tyler-technologies-oss/forge-mcp#blocks-mcp-adjustments
/plugin install forge@tyler-forgeVerify installation:
/skillsYou may need to restart Claude or run
/reload-skillsif the skill doesn't appear.
Update the plugin:
claude plugin marketplace update tyler-forgeFor local development:
claude --plugin-dir /path/to/forge-mcp/pluginClaude Code (MCP Only)
claude mcp add -t stdio -s [scope] forge -- npx -y @tylertech/forge-mcp@latest
[scope]must beuser,project, orlocal. See Claude Code MCP docs.
Codex CLI
Add to ~/.codex/config.toml:
[mcp_servers.forge]
command = "npx"
args = ["-y", "@tylertech/forge-mcp@latest"]Gemini CLI
gemini mcp add -t stdio -s [scope] forge npx -y @tylertech/forge-mcp@latestVS Code
Add to .vscode/mcp.json:
{
"servers": {
"forge": {
"command": "npx",
"args": ["-y", "@tylertech/forge-mcp@latest"],
"type": "stdio"
}
}
}Or use Command Palette → MCP: Add Server... → Command (stdio) → enter npx -y @tylertech/forge-mcp@latest.
Claude Desktop
Edit claude_desktop_config.json (Settings → Developer → Edit Config):
{
"mcpServers": {
"forge": {
"command": "npx",
"args": ["-y", "@tylertech/forge-mcp@latest"]
}
}
}Core Concepts
Forge Blocks
Blocks are pre-built UI patterns that show Forge components working together in context. They demonstrate real-world scenarios like login forms, data tables, application layouts, and dashboards—complete with proper layout, typography, spacing, and component composition.
Why use blocks?
- See how multiple components work together in realistic scenarios
- Handcrafted examples following Forge design system best practices
- Prevent common mistakes and ensure consistent UI patterns
How to use blocks:
# Search for blocks by functionality
get_forge_blocks(query: "login form")
get_forge_blocks(query: "data table with sorting")
# Find blocks using a specific component
get_forge_blocks(component: "forge-card")
get_forge_blocks(component: "forge-table")
# Browse by category
get_forge_blocks(category: "forms")
get_forge_blocks(category: "application-layout")
# Get full code for a specific block
get_forge_blocks(blockId: "src/blocks/forms/login")Component Documentation
Access complete API documentation including properties, events, slots, CSS parts, and CSS custom properties.
# Full API documentation
get_component_docs(componentName: "forge-dialog")
# Summary overview
get_component_docs(componentName: "forge-dialog", format: "summary")For HTML usage examples, use get_forge_blocks(component: "forge-dialog") instead—every component has a dedicated block demonstrating its usage.
Capabilities
Tools
| Tool | Description |
|------|-------------|
| get_forge_blocks | Search and retrieve pre-built UI patterns (use FIRST before generating UI code) |
| get_component_docs | Get component API documentation (full or summary) |
| list_components | Browse all available components |
| find_components | Search components by name or functionality |
| validate_component_api | Validate component API usage in generated code |
| get_design_tokens | Get design tokens (colors, spacing, typography, etc.) |
| setup_typography | Typography setup and usage guidelines |
| setup_icons | Icon system installation and usage |
| find_icons | Search icons by name or keywords |
| setup_framework | Framework-specific setup (Angular, React, Vue, Svelte, Lit) |
| get_version_migration_guide | Migration guides between Forge versions |
| get_usage_guide | General usage patterns and best practices |
Resources
| URI | Description |
|-----|-------------|
| forge://components | All components overview |
| forge://component/{tagName} | Specific component documentation |
| forge://installation | Installation guide |
| forge://usage | Usage guide |
| forge://framework/{name} | Framework guides (angular, react, vue, svelte, lit) |
| forge://design-tokens | All design tokens |
| forge://design-tokens/{category} | Token categories (color, spacing, typography, animation, border, elevation, shape, layering) |
| forge://icons | Icons guide |
Prompts
| Prompt | Description |
|--------|-------------|
| forge_mode | Sets baseline rules for Forge-specific tasks |
Recommended Workflow
- Search blocks first — Before writing any Forge UI code, call
get_forge_blocksto find pre-built patterns and component-specific usage examples - Check component API — Use
get_component_docsfor full API details when needed - Validate before finalizing — Call
validate_component_apito verify your code uses correct APIs
Development
Commands:
pnpm run dev # Watch mode
pnpm run debug # Test with MCP inspector
pnpm run build # Build for productionContributing
See CONTRIBUTING.md for guidelines. Issues and PRs welcome.
License
Apache-2.0 License - see LICENSE file for details.
Note: Always validate AI output against official documentation.
Part of the Tyler Technologies Open Source initiative
