mcp-lawted-components
v4.0.0
Published
MCP server for UI component library
Readme
Lawted Components MCP Server
An MCP server that provides access to Lawted UI component documentation for LLMs.
What is MCP?
The Model Context Protocol (MCP) is a standardized way for applications to provide context to LLMs.
Features
- Provides component library documentation via MCP
- Allows agents to list and query available UI components
- Exposes detailed component properties, examples, and usage patterns
Components Directory
The server reads component definitions from JSON files in a specified components directory. You must provide the path to this directory when running the tool.
Usage
This tool is designed to be run using npx, which downloads and executes the package without needing a local installation.
Prerequisites
- Node.js 18+
- npm (for using
npx)
Running the Server
You need to specify the path to your components directory using either the --components-dir (or -d) flag or the LAWTED_COMPONENTS_DIR environment variable.
Example Configuration (e.g., for Cursor):
Some tools might require you to specify the command and arguments separately. Here's an example of how you might configure it in a tool like Cursor:
"lawted-components": {
"command": "npx",
"args": [
"-y",
"mcp-lawted-components",
"-d",
"/path/to/your/components"
]
}(Remember to replace /path/to/your/components with your actual path)
Available Resources (For MCP Clients)
lawted://components- List all available componentslawted://component/{name}- Get details about a specific componentlawted://search/{query}- Search for components
Available Tools (For MCP Clients)
list-components- List all available components (returns a JSON string summary)get-component- Get detailed information about a specific component (returns a JSON string)
Component Schema
Component JSON files should follow the structure defined in JSON-CREATE.md. See that file for the detailed schema.
Previously, an example schema was shown here, but due to its complexity, please refer to JSON-CREATE.md for the canonical definition.
Development
If you want to contribute or run the server locally for development:
Installation
git clone <repository-url>
cd mcp-lawted-components
npm installBuild
npm run buildRun Locally
node dist/index.js -d /path/to/your/components