Skip to content

Vue Router

4.78 / 5 composite score · 88.8% API recall · 49 questions evaluated

Vue Docs MCP provides deep access to the official Vue Router documentation, covering route configuration, navigation guards, dynamic routing, lazy loading, data loaders, file-based routing, and the full API reference.

Activation

Vue Router is not enabled by default. Activate it with:

set_framework_preferences(vue_router=true)

Tools

Semantic search over Vue Router documentation. Covers guide pages, data loaders, file-based routing, migration guides, and API reference.

ParameterTypeDefaultDescription
querystringDeveloper question or topic (max 2000 chars)
scopestring"all"Documentation section to search within
max_resultsinteger3Number of sections to return (1-20)

Scope values: all, guide, guide/essentials, guide/advanced, guide/migration, data-loaders, file-based-routing

vue_router_api_lookup

Fast exact-match API reference lookup for Vue Router APIs.

ParameterTypeDefaultDescription
namestringAPI name to look up (e.g. useRouter, createRouter, beforeEach)

Example API names: useRouter, useRoute, useLink, createRouter, createWebHistory, createWebHashHistory, createMemoryHistory, RouterLink, RouterView, beforeEach, beforeResolve, afterEach, onBeforeRouteLeave, onBeforeRouteUpdate, scrollBehavior

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

ParameterTypeDefaultDescription
namestringAPI name or concept to explore

Resources

URIDescription
vue-router://topicsFull table of contents
vue-router://topics/{section}TOC for a specific section (e.g. vue-router://topics/guide/advanced)
vue-router://pages/{path}Raw markdown of any doc page (e.g. vue-router://pages/guide/essentials/navigation)
vue-router://api/indexComplete API entity index grouped by type
vue-router://api/entities/{name}Details for a specific API (e.g. vue-router://api/entities/useRouter)
vue-router://scopesAll valid search scope values

Prompts

PromptParametersDescription
debug_vue_router_issuesymptom, code_snippet (optional)Systematic debugging for routing issues: navigation failures, guard problems, params not updating
compare_vue_router_apisitems (comma-separated)Side-by-side comparison (e.g. router.push, router.replace or beforeEach, beforeEnter)
migrate_vue_router_patternfrom_pattern, to_patternMigration guide (e.g. Vue Router 3 to 4, Options API guards to Composition API)

Benchmarks vs Context7

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

Overall Scores

MetricVue Docs MCPContext7
Relevance4.943.53
Completeness4.783.04
Correctness4.863.18
API Coverage4.432.33
Conciseness4.924.59
Composite4.783.33

Retrieval and Cost

MetricVue Docs MCPContext7
Path Recall95.9%42.9%
API Recall88.8%34.4%
Avg Latency2.76s1.83s
Cost per Query (user-facing)Free$0.002

Notes

  • Context7 performs notably better on Vue Router (3.33 composite) than on Vue.js core (2.41), suggesting their Vue Router documentation coverage is stronger.
  • Our API recall (88.8%) is slightly lower than Vue.js (98.7%) because Vue Router's TypeDoc-generated API docs are not yet included in ingestion (they require a build step). This will improve once TypeDoc generation is integrated.
  • The evaluation framework is open source in the eval/ directory.