---
url: /frameworks/formkit.md
---
# FormKit

4.59 / 5 composite score · 100.0% API recall · 55 questions evaluated

Vue Docs MCP provides deep access to the official [FormKit documentation](https://formkit.com), covering Vue's most ergonomic form framework: `<FormKit>` and `<FormKitSchema>` components, the core node primitive, validation rules, all 42+ input types, the official plugin set (auto-animate, multi-step, local-storage, zod, floating-labels, ...), the i18n system, theming, and the full @formkit/\* package surface (~320 API entries).

::: tip Big API surface
FormKit ships 12 packages. The MCP indexes them all: `@formkit/vue`, `@formkit/core`, `@formkit/inputs`, `@formkit/validation`, `@formkit/i18n`, `@formkit/icons`, `@formkit/themes`, `@formkit/utils`, `@formkit/observer`, `@formkit/schema`, `@formkit/addons`, plus the official plugin packages.
:::

## Usage

Pass `framework: "formkit"` to `docs_search`, `api_lookup` and `get_related`. No activation is needed: every framework is always available.

## Tools

### `docs_search`

Semantic search over FormKit documentation. Uses the standard 6-step retrieval pipeline: embed query, hybrid search (dense + BM25), resolve HyPE hits, expand cross-references, rerank, and reconstruct into readable markdown.

| Parameter | Type | Default | Description |
|---|---|---|---|
| `framework` | `string` | | Always `"formkit"` |
| `query` | `string` | | Developer question or topic (max 2000 chars) |
| `scope` | `string` | `"all"` | Documentation section to search within |
| `max_results` | `integer` | `3` | Number of sections to return (1-20) |

**Scope values:** `all`, `1.getting-started`, `2.essentials`, `3.inputs`, `4.plugins`, `5.guides`, `6.api-reference`

### `api_lookup`

Fast exact-match API reference lookup with fuzzy fallback. Returns type signatures, descriptions, and usage examples directly from the documentation.

| Parameter | Type | Default | Description |
|---|---|---|---|
| `framework` | `string` | | Always `"formkit"` |
| `api_name` | `string` | | API name to look up (e.g. `FormKit`, `createInput`, `createNode`, `useFormKitNodeById`) |

### `get_related`

Find related APIs, concepts, and documentation pages for a given API or topic.

| Parameter | Type | Default | Description |
|---|---|---|---|
| `framework` | `string` | | Always `"formkit"` |
| `topic` | `string` | | API name or concept to explore |

## Resources

| URI | Description |
|---|---|
| `formkit://topics` | Full table of contents |
| `formkit://topics/{section}` | TOC for a specific section (e.g. `formkit://topics/3.inputs`) |
| `formkit://pages/{path}` | Raw markdown of any doc page (e.g. `formkit://pages/3.inputs/text`) |
| `formkit://api/index` | Complete API entity index grouped by type |
| `formkit://api/entities/{name}` | Details for a specific API (e.g. `formkit://api/entities/createInput`) |
| `formkit://scopes` | All valid search scope values |

## Prompts

| Prompt | Parameters | Description |
|---|---|---|
| `debug_issue` | `framework`, `symptom`, `code_snippet` (optional) | Systematic debugging workflow |
| `compare_apis` | `framework`, `items` (comma-separated) | Side-by-side comparison (e.g. `group, list`) |
| `migrate_pattern` | `framework`, `from_pattern`, `to_pattern` | Migration guide between patterns |

## Coverage

| Area | What's indexed |
|---|---|
| Core components | `<FormKit>`, `<FormKitSchema>`, `<FormKitMessages>`, `<FormKitIcon>`, `<FormKitSummary>` |
| Input types | All 42 official inputs: text, email, password, autocomplete, datepicker, taglist, repeater, multi-step, ... |
| Form composition | `form`, `group`, `list`, `repeater` — nested data structuring without prop drilling |
| Validation | Built-in rules, custom rules, async validation, message localization, conditional rules |
| Schema | `FormKitSchema`, `$formkit`/`$el`/`$cmp` shorthands, `if`/`for`/`bind` directives, reactive `$`-expressions |
| Core node | `createNode`, `getNode`, `useFormKitNodeById`, events (input, commit, prop, child, submit) |
| Plugins | auto-animate, auto-height-textarea, floating-labels, local-storage, multi-step, barcode, inertia, zod |
| i18n | `@formkit/i18n` locales, runtime locale switching, message overrides |
| Theming | Genesis / Regenesis themes, Tailwind theme guide, sectionsSchema overrides |
| API reference | ~320 typed API entries across 12 `@formkit/*` packages |
| Guides | Custom inputs, Tailwind themes, restructuring sections, production optimization |
| Integration | Nuxt module (`@formkit/nuxt`), SSR-safe hydration |

## Benchmarks vs Context7

Evaluated on 50 FormKit questions scored by an LLM judge (Gemini, temperature 0) across 5 dimensions on a 1-5 scale.

::: info Methodology
Each question has a ground-truth answer with expected API names and documentation paths. Both providers receive the same question and return documentation context. The judge scores the retrieved context on relevance, completeness, correctness, API coverage, and conciseness. See the `eval/` directory in the repository for the full evaluation framework.
:::

### Overall Scores

| Metric | Vue Docs MCP | Context7 |
|---|---|---|
| Relevance | **4.85** | 4.62 |
| Completeness | **4.33** | 4.20 |
| Correctness | **4.55** | 4.47 |
| API Coverage | **4.58** | 4.53 |
| Conciseness | 4.62 | **4.80** |
| **Composite** | **4.59** | 4.52 |

### Retrieval and Cost

| Metric | Vue Docs MCP | Context7 |
|---|---|---|
| Path Recall | **95.5%** | 80.9% |
| API Recall | 100.0% | 100.0% |
| Avg Response Tokens | 2,751 | **893** |
| Avg Latency | **0.70s** | 1.75s |
| P95 Latency | **1.14s** | 2.15s |
| Cost per Query (user-facing) | **Free** | $0.002 |

### Notes on Fairness

* Context7 is a general-purpose service covering 9000+ libraries. Vue Docs MCP is purpose-built for the Vue ecosystem.
* Both providers index `formkit/docs-content` (the same source markdown).
* The evaluation framework is open source in the `eval/` directory. Run `make eval-compare` to reproduce.