@ingenx-io/valets-schema-mcp-server 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +65 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# @ingenx-io/valets-schema-mcp-server
|
|
2
|
+
|
|
3
|
+
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).
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
### Claude Desktop
|
|
8
|
+
|
|
9
|
+
Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
|
|
10
|
+
|
|
11
|
+
```json
|
|
12
|
+
{
|
|
13
|
+
"mcpServers": {
|
|
14
|
+
"valets-schema": {
|
|
15
|
+
"command": "npx",
|
|
16
|
+
"args": ["-y", "@ingenx-io/valets-schema-mcp-server"]
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### Claude Code
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
claude mcp add valets-schema -- npx -y @ingenx-io/valets-schema-mcp-server
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Other MCP clients
|
|
29
|
+
|
|
30
|
+
```json
|
|
31
|
+
{
|
|
32
|
+
"command": "npx",
|
|
33
|
+
"args": ["-y", "@ingenx-io/valets-schema-mcp-server"]
|
|
34
|
+
}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Tools
|
|
38
|
+
|
|
39
|
+
| Tool | Description |
|
|
40
|
+
|------|-------------|
|
|
41
|
+
| `schema_overview` | High-level summary of all models and enums — start here |
|
|
42
|
+
| `get_schema` | JSON Schema for a specific model or enum (kebab-case, e.g. `order`, `payment-status`) |
|
|
43
|
+
| `get_doc` | Raw Markdown documentation for a schema page (e.g. `models/order`, `enums/payment-method`) |
|
|
44
|
+
| `search_docs` | Keyword search across all documentation pages |
|
|
45
|
+
| `list_decisions` | All data model decisions (D00–D37+) with status and summary |
|
|
46
|
+
| `get_decision` | Full details for a specific decision by ID (e.g. `D12`) |
|
|
47
|
+
| `get_openapi` | OpenAPI 3.1 spec — full or filtered to a single component (e.g. `Order`, `OrderCreate`) |
|
|
48
|
+
|
|
49
|
+
## Resources
|
|
50
|
+
|
|
51
|
+
| URI | Description |
|
|
52
|
+
|-----|-------------|
|
|
53
|
+
| `valets://schemas.json` | Consolidated JSON Schema bundle for all models and enums |
|
|
54
|
+
| `valets://llms.txt` | LLM-optimized summary of the Valets data model |
|
|
55
|
+
| `valets://openapi.yaml` | OpenAPI 3.1 specification |
|
|
56
|
+
| `valets://decisions.json` | Data model decisions metadata |
|
|
57
|
+
|
|
58
|
+
## Configuration
|
|
59
|
+
|
|
60
|
+
| Variable | Default | Description |
|
|
61
|
+
|----------|---------|-------------|
|
|
62
|
+
| `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. |
|
|
63
|
+
| `VALETS_CACHE_TTL` | `300000` | Cache TTL in milliseconds for remotely fetched data (default: 5 minutes). |
|
|
64
|
+
|
|
65
|
+
When `VALETS_SCHEMA_URL` is not set, the server uses the bundled schema snapshot included in the package.
|