open-index/open-npm huggingface dataset:
npm package: @ingenx-io/valets-schema-mcp-server
Description: MCP server exposing @valets/schema documentation to AI agents
Latest version: 0.1.3

# @ingenx-io/valets-schema-mcp-server

MCP server that exposes the [Valets](https://github.com/IngenX-IO/valets-data-architecture) data model documentation to AI agents via the [Model Context Protocol](https://modelcontextprotocol.io).

## Usage

### Claude Desktop

Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:

```json
{
  "mcpServers": {
    "valets-schema": {
      "command": "npx",
      "args": ["-y", "@ingenx-io/valets-schema-mcp-server"]
    }
  }
}
```

### Claude Code

```bash
claude mcp add valets-schema -- npx -y @ingenx-io/valets-schema-mcp-server
```

### Other MCP clients

```json
{
  "command": "npx",
  "args": ["-y", "@ingenx-io/valets-schema-mcp-server"]
}
```

## Tools

| Tool | Description |
|------|-------------|
| `schema_overview` | High-level summary of all models and enums — start here |
| `get_schema` | JSON Schema for a specific model or enum (kebab-case, e.g. `order`, `payment-status`) |
| `get_doc` | Raw Markdown documentation for a schema page (e.g. `models/order`, `enums/payment-method`) |
| `search_docs` | Keyword search across all documentation pages |
| `list_decisions` | All data model decisions (D00–D37+) with status and summary |
| `get_decision` | Full details for a specific decision by ID (e.g. `D12`) |
| `get_openapi` | OpenAPI 3.1 spec — full or filtered to a single component (e.g. `Order`, `OrderCreate`) |

## Resources

| URI | Description |
|-----|-------------|
| `valets://schemas.json` | Consolidated JSON Schema bundle for all models and enums |
| `valets://llms.txt` | LLM-optimized summary of the Valets data model |
| `valets://openapi.yaml` | OpenAPI 3.1 specification |
| `valets://decisions.json` | Data model decisions metadata |

## Configuration

| Variable | Default | Description |
|----------|---------|-------------|
| `VALETS_SCHEMA_URL` | _(unset)_ | Base URL of a deployed Valets Docusaurus site. When set, the server fetches live data from this URL and falls back to bundled data on failure. |
| `VALETS_CACHE_TTL` | `300000` | Cache TTL in milliseconds for remotely fetched data (default: 5 minutes). |

When `VALETS_SCHEMA_URL` is not set, the server uses the bundled schema snapshot included in the package.