Skip to content

Commit 74ea1b5

Browse files
Miroslav Adamecclaude
andcommitted
doc: document concepts tool and resource in readme
Add get_dotvvm_concept_docs tool, dotvvm://concepts resource, concept data sources, and concepts.ts to the README, which previously covered only the control tools. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 8c91307 commit 74ea1b5

1 file changed

Lines changed: 16 additions & 4 deletions

File tree

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,15 @@ Restart Claude Desktop after editing the config.
6868
|------|-------------|
6969
| `list_dotvvm_controls` | Lists all discovered controls. Accepts optional `category` or `prefix` filter. |
7070
| `get_dotvvm_control_docs` | Returns composed Markdown docs for a control (description, HTML output, code samples, ViewModels). |
71+
| `get_dotvvm_concept_docs` | Returns Markdown docs for a DotVVM framework concept page. Takes a `path` like `data-binding/value-binding` or `routing/overview`. |
72+
73+
## MCP resources
74+
75+
| Resource URI | Description |
76+
|--------------|-------------|
77+
| `dotvvm://concepts` | Index of all DotVVM concept documentation pages, grouped by category and subcategory. Read this to discover valid `path` values for `get_dotvvm_concept_docs`. |
78+
79+
Concept documentation covers framework topics such as data binding (value binding, resource binding, binding context), routing (parameters, localization, redirection), validation (client-side, extensibility), viewmodels (filters, protection, caching), control development (markup controls, code-only controls, properties), layout (master pages, SPA), security (authentication, authorization), localization, and diagnostics.
7180

7281
### Control naming
7382

@@ -101,8 +110,9 @@ Cache TTL is **30 days**. To force a refresh, delete the relevant `.json` file o
101110

102111
```
103112
src/
104-
├── index.ts # MCP server entry point, tool definitions
113+
├── index.ts # MCP server entry point, tool + resource definitions
105114
├── controls.ts # Control discovery via GitHub API + prefix resolution
115+
├── concepts.ts # Concept page discovery + index formatting
106116
├── fetcher.ts # Raw content fetcher + Markdown composition
107117
└── cache.ts # File-based disk cache (30-day TTL)
108118
```
@@ -144,7 +154,9 @@ To point an MCP client at your local checkout instead of the published package:
144154

145155
All documentation is fetched from:
146156

147-
- **Directory listings:** `https://api.github.com/repos/riganti/dotvvm-docs/contents/Controls/{category}?ref=4.0`
148-
- **Raw content:** `https://raw.githubusercontent.com/riganti/dotvvm-docs/4.0/Controls/{category}/{ControlName}/`
157+
- **Control directory listings:** `https://api.github.com/repos/riganti/dotvvm-docs/contents/Controls/{category}?ref=4.0`
158+
- **Control raw content:** `https://raw.githubusercontent.com/riganti/dotvvm-docs/4.0/Controls/{category}/{ControlName}/`
159+
- **Concept directory listings:** `https://api.github.com/repos/riganti/dotvvm-docs/contents/Pages/concepts?ref=4.0`
160+
- **Concept raw content:** `https://raw.githubusercontent.com/riganti/dotvvm-docs/4.0/Pages/concepts/{category}/{page}.md`
149161

150-
Each control directory may contain `control.md`, `output.md`, and `sample{N}/` subdirectories with `page.dothtml`, `ViewModel.cs`, and `sample.md`.
162+
Each control directory may contain `control.md`, `output.md`, and `sample{N}/` subdirectories with `page.dothtml`, `ViewModel.cs`, and `sample.md`. Concept pages are `.md` files organized into categories and subcategories.

0 commit comments

Comments
 (0)