Skip to content

Vue Flow

4.82 / 5 composite score · 95.0% API recall · 50 questions evaluated

Vue Docs MCP provides deep access to the official Vue Flow documentation, covering the node-based diagram library: the <VueFlow> container, the <Handle> connection point, the addon packages (Background, Controls, MiniMap, NodeToolbar, NodeResizer), the composables (useVueFlow, useNode, useEdge, useHandle, useNodesData, useNodesInitialized, useKeyPress, ...), the edge primitives + path helpers (BaseEdge, BezierEdge, getBezierPath, getSmoothStepPath), controlled-flow patterns, custom node/edge authoring, theming, and the worked examples (drag-and-drop, dagre/elk auto-layout, validation, helper lines, multi-step wizards).

Activation

Vue Flow is not enabled by default. Call set_framework_preferences to activate it:

set_framework_preferences(vue_flow=true)

Tools

Semantic search over Vue Flow 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.

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, examples

vue_flow_api_lookup

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

ParameterTypeDefaultDescription
api_namestringAPI name to look up (e.g. VueFlow, useVueFlow, Handle, BaseEdge)

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

ParameterTypeDefaultDescription
topicstringAPI name or concept to explore

Resources

URIDescription
vue-flow://topicsFull table of contents
vue-flow://topics/{section}TOC for a specific section (e.g. vue-flow://topics/guide)
vue-flow://pages/{path}Raw markdown of any doc page (e.g. vue-flow://pages/guide/node)
vue-flow://api/indexComplete API entity index
vue-flow://api/entities/{name}Details for a specific API (e.g. vue-flow://api/entities/useVueFlow)
vue-flow://scopesAll valid search scope values

Prompts

PromptParametersDescription
debug_vue_flow_issuesymptom, code_snippet (optional)Systematic debugging workflow
compare_vue_flow_apisitems (comma-separated)Side-by-side comparison (e.g. BezierEdge, SmoothStepEdge, StraightEdge)
migrate_vue_flow_patternfrom_pattern, to_patternMigration guide between patterns

Coverage

AreaWhat's indexed
Core<VueFlow> container, <Handle> connection point, <Panel> overlay
Addon components<Background>, <Controls>, <ControlButton>, <MiniMap>, <MiniMapNode>, <NodeToolbar>, <NodeResizer>, <NodeResizeControl>
Edges<BaseEdge>, <BezierEdge>, <SmoothStepEdge>, <StepEdge>, <StraightEdge>, <EdgeLabelRenderer> and the path helpers getBezierPath, getSimpleBezierPath, getSmoothStepPath, getStraightPath, getEdgeCenter, getMarkerEnd
ComposablesuseVueFlow, useNode, useEdge, useHandle, useNodeId, useConnection, useHandleConnections, useNodeConnections, useNodesData, useEdgesData, useNodesInitialized, useKeyPress, useZoomPanHelper, useGetPointerPosition
Controlled flowuseNodesState, useEdgesState, applyNodeChanges, applyEdgeChanges
Errors / enumsVueFlowError, ErrorCode, isErrorOfType, ConnectionMode, ConnectionLineType, Position, MarkerType, PanelPosition, BackgroundVariant
Examplesdrag-and-drop, dagre/ELK auto-layout (simple + animated), connection validation, connection radius, custom connection line, edge markers, loopback, updatable edges, helper lines, multi-step interaction, hidden nodes, confirm-on-delete
ConceptsTheming via CSS custom properties, save/restore via FlowExportObject, multi-instance via id scoping, viewport configuration, troubleshooting

Benchmarks vs Context7

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

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

MetricVue Docs MCPContext7
Relevance4.924.92
Completeness4.664.62
Correctness4.824.76
API Coverage4.744.62
Conciseness4.964.76
Composite4.824.74

Retrieval and Cost

MetricVue Docs MCPContext7
Path Recall98.0%94.0%
API Recall95.0%92.0%
Avg Response Tokens3,7521,112
Avg Latency0.83s1.73s
P95 Latency1.29s2.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.
  • Vue Flow's API reference is generated by TypeDoc into docs/src/typedocs/ at build time; we skip running TypeDoc during ingestion (it requires the full pnpm install of the docs workspace plus the typedoc-plugin-markdown chain). The seed entity dictionary covers the public surface from each @vue-flow/* package's index.ts. Both providers face the same prose-only source for the conceptual guide pages.
  • The evaluation framework is open source in the eval/ directory. Run make eval-compare to reproduce.