Hein
f737b1d11d
- refactor state structure to include app, layout, navigation, owner, program, session, and user - add slices for managing program, session, owner, user, layout, navigation, and app states - create context provider for global state with automatic fetching and throttling - implement persistence using IndexedDB with localStorage fallback - add comprehensive README documentation for usage and API
103 lines
2.1 KiB
Markdown
103 lines
2.1 KiB
Markdown
# Oranguru MCP Server
|
|
|
|
Model Context Protocol server for Oranguru component library documentation and code generation.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install @warkypublic/oranguru
|
|
```
|
|
|
|
## Configuration
|
|
|
|
Add to your Claude Code MCP settings (`~/.claude/mcp_settings.json`):
|
|
|
|
```json
|
|
{
|
|
"mcpServers": {
|
|
"oranguru-docs": {
|
|
"command": "node",
|
|
"args": ["./node_modules/@warkypublic/oranguru/mcp/server.js"]
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
Or use npx:
|
|
|
|
```json
|
|
{
|
|
"mcpServers": {
|
|
"oranguru-docs": {
|
|
"command": "npx",
|
|
"args": ["-y", "@warkypublic/oranguru", "mcp"]
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## Available Tools
|
|
|
|
### `list_components`
|
|
List all available Oranguru components
|
|
|
|
**Returns:** JSON array of components with name, description, and exports
|
|
|
|
### `get_component_docs`
|
|
Get detailed documentation for a specific component
|
|
|
|
**Parameters:**
|
|
- `component` (required): Component name (MantineBetterMenu, Gridler, Former, etc.)
|
|
|
|
**Returns:** JSON object with component details, exports, and usage information
|
|
|
|
### `get_component_example`
|
|
Get code examples for a specific component
|
|
|
|
**Parameters:**
|
|
- `component` (required): Component name
|
|
- `variant` (optional): Example variant ('basic', 'local', 'server', etc.)
|
|
|
|
**Returns:** Code example string
|
|
|
|
## Available Resources
|
|
|
|
### `oranguru://docs/readme`
|
|
Full README documentation
|
|
|
|
**MIME Type:** text/markdown
|
|
|
|
### `oranguru://docs/components`
|
|
Component list in JSON format
|
|
|
|
**MIME Type:** application/json
|
|
|
|
## Components
|
|
|
|
- **MantineBetterMenu** - Enhanced context menus
|
|
- **Gridler** - Data grid component
|
|
- **Former** - Form component with React Hook Form
|
|
- **FormerControllers** - Form input controls
|
|
- **Boxer** - Advanced combobox/select
|
|
- **ErrorBoundary** - Error boundary components
|
|
- **GlobalStateStore** - Global state management
|
|
|
|
## Usage in Claude Code
|
|
|
|
Once configured, you can ask Claude Code:
|
|
|
|
- "Show me examples of the Gridler component"
|
|
- "Get documentation for the Former component"
|
|
- "List all Oranguru components"
|
|
- "Generate a code example for Boxer with server-side data"
|
|
|
|
## Running Locally
|
|
|
|
```bash
|
|
npm run mcp
|
|
```
|
|
|
|
## License
|
|
|
|
See main package LICENSE file
|