Getting Started

MCP server

Connect Flashboard Docs to Cursor, VS Code, and other AI tools through the built-in MCP server at flashboard.pepperfm.com.

Flashboard Docs exposes a built-in MCP server so AI tools can query the documentation directly instead of relying on vague prompts or copied snippets.

Endpoint

Use this MCP endpoint:

https://flashboard.pepperfm.com/mcp

This endpoint is served by @nuxtjs/mcp-toolkit inside the docs site.

If your client supports install deeplinks, use:

  • Cursor: https://flashboard.pepperfm.com/mcp/deeplink
  • VS Code: https://flashboard.pepperfm.com/mcp/deeplink?ide=vscode

Manual configuration

For clients that accept MCP servers as HTTP endpoints, configure a server named flashboard-docs:

{
  "mcpServers": {
    "flashboard-docs": {
      "type": "http",
      "url": "https://flashboard.pepperfm.com/mcp"
    }
  }
}

Available tools

The docs MCP currently exposes these tools:

  • list-pages — list all documentation pages with paths, descriptions, and section metadata
  • get-page — get full page content, headings, and code-example metadata
  • list-sections — list top-level docs sections and their page counts
  • get-page-toc — return headings for a page
  • get-raw-markdown — return raw markdown for a page
  • get-section — return one section by heading from a page
  • search-pages — search titles, descriptions, headings, and markdown content
  • list-code-examples — list code examples across the docs
  • get-code-example — return one concrete snippet from a page
  • get-site-meta — return site-level metadata, repo URLs, and the MCP endpoint itself
  1. Call list-sections or list-pages to understand the docs structure.
  2. Use search-pages if you know the topic but not the exact page.
  3. Use get-page for full context.
  4. Use get-section when only one section is needed.
  5. Use list-code-examples and get-code-example to extract implementation snippets.

Raw markdown endpoint

For debugging and manual inspection, the docs site also exposes raw markdown per page:

https://flashboard.pepperfm.com/raw/<path>.md

Example:

https://flashboard.pepperfm.com/raw/getting-started/installation.md

Maintenance note

If documentation pages, section headings, navigation structure, or code-example formats change, review the MCP implementation in:

  • server/mcp/tools/*
  • server/mcp/utils/docs.ts
  • server/routes/raw/[...slug].md.get.ts

The docs content and MCP output should evolve together.