DOCS v0.1.0-alpha · synced with main · 25 May 2026

The Guides.

Read the framework end to end, or jump to the part you need. Every guide is paired with runnable examples in TypeScript and JavaScript, and links straight to its source on GitHub.

guides

across 7 sections

live

0 in progress

~180

pages of docs

~3,800 lines of MD

↗

on GitHub

mcp-rune / mcp-rune

★ FEATURED view all ↗

01 / 03

START

Quickstart

10 minutes to a running MCP server. Scaffold, declare one model, ship.

The DSL at the heart of mcp-rune. Sections, field groups, three strategies.

Build rich UIs that render inside Claude Desktop. Bi-directional protocol.

18 min Read →

I. SECTION

Getting Started

3 GUIDES

Your first day with mcp-rune — install, scaffold, and run a server end to end.

§ 01 Quickstart Scaffold a project, register your first model, and call a tool from Claude Desktop in one terminal session. clisetup live 8 min → § 02 Project structure Where models, prompts, tools, apps and the domain registry live in a generated mcp-rune project. layout live 4 min → § 03 Configuring the API The static api block: endpoint, convention, namespace, readOnly, custom actions, and compound IDs. modelshttp live 12 min →

II. SECTION

The Prompt DSL

4 GUIDES

The declarative language at the center of the framework. Sections describe the user journey; field groups carry validation. The framework writes everything in between.

§ 01 Prompt Creation Stateless, hybrid or stateful. Sections vs fieldGroups. Per-section content enrichment and askPrompts. coredsl live 14 min → § 02 Derivation Framework The 5-layer architecture: schema → grouping → section docs → assembly → behavioral instructions. architecture live 11 min → § 03 Sections & Field Groups User-facing sections versus validation-facing field groups, and how layouts flow between them. ui live 6 min → § 04 Stateful Strategies Turn-taking, section-by-section validation, and the StatefulStrategy API for 20+ field workflows. advanced live 9 min →

III. SECTION

Tools & Services

3 GUIDES

How tool classes hook into ModelService, the ApiClient pipeline, and the multi-step workflow runner.

§ 01 Tool Creation Two layers: generic CRUD tools in mcp-rune, server-specific tools in your project. Pipeline, interceptors, validators. tools live 13 min → § 02 Service Layer ModelService orchestrates EndpointResolver + Convention + ApiClient. Where domain errors are raised and translated. services live 10 min → § 03 Workflow Creation Multi-step LLM-driven workflows. get_workflow_step, contextHints, the fetch-analyze loop pattern. workflows live 15 min →

IV. SECTION

Apps, Search & Forms

4 GUIDES

Rich UI surfaces — sandboxed HTML apps, schema-derived search filters, and per-field-group form customization.

§ 01 MCP Apps Schema-driven HTML forms rendered inside the client. ontoolinput, ontoolresult, callServerTool — the whole protocol. appsui live 18 min → § 02 Apps Architecture How the framework resolves a ui:// resource, sandboxes the iframe, and wires bidirectional message channels. appsprotocol live 8 min → § 03 Search Filters The shared filter contract between MCP and a Rails backend. text · enum · relation · date_range · integer_range. search live 11 min → § 04 Model Form Customization Horizontal label-field grids, row layouts, stacked variants — and per-fieldGroup overrides. appsui live 7 min →

V. SECTION

Analysis & Memory

3 GUIDES

Patterns for large-result LLM workflows: pgvector-backed memories, stratified sampling, and the transient-context protocol that keeps context windows small.

§ 01 Analysis Memories A five-tool feature for LLM-driven qualitative analysis over thousands of paginated records, with pgvector recall. analysisvector live 22 min → § 02 Proximity Sampling Stratified, proximity-bucketed sample patterns for finding rare cases across long-tail distributions. analysissampling live 6 min → § 03 Transient Context Protocol Server-to-client protocol for collapsing transient tool results after a follow-up call has consumed them. protocolcontext live 5 min →

VI. SECTION

Auth & Transport

1 GUIDE

OAuth 2.0 the spec-compliant way — PRM, DCR, PKCE, resource indicators, and the WWW-Authenticate dance.

§ 01 OAuth 2.0 Discovery RFC 9728 PRM · RFC 8414 server metadata · RFC 7591 DCR · RFC 7636 PKCE · RFC 8707 resource indicators. authrfc live 9 min →

VII. SECTION

Domain Intelligence

1 GUIDE

The declarative domain layer: concepts, business rules, multi-step workflow definitions, and diagram templates the LLM can reach for.

§ 01 Domain Knowledge Framework DomainConcept, BusinessRule, WorkflowDefinition, DiagramTemplate — the declarative domain registry. domain live 24 min →

Something missing?

Every guide lives next to the code that implements it. Open a PR against docs/guides/ — or file an RFC if you'd like the framework to grow.

Open RFC → Edit on GitHub ↗