mcp-starlight

mcp-starlight

Enables MCP clients to search and retrieve documentation from an Astro Starlight docs site by reading a pre-built catalog. Supports locale and version filtering, as well as structured data collections.

Category
Visit Server

README

@stellayazilim/mcp-starlight

Give any Astro Starlight docs site an MCP server.

No hosting. The integration writes a catalog into your build; the server runs on the reader's machine via npx and fetches it. A static host only ever has to answer GET for a JSON file — which is the one thing it does. GitHub Pages, S3 and plain nginx all work unchanged.

Locale- and version-aware, and extensible with structured data of your own.

Install

npm install @stellayazilim/mcp-starlight
// astro.config.mjs
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';
import starlightMcp from '@stellayazilim/mcp-starlight';

export default defineConfig({
  site: 'https://example.com',
  integrations: [
    starlight({ title: 'My Docs' }),
    starlightMcp({ siteLabel: 'My Product' }),
  ],
});

Build the site. You now have dist/mcp-catalog.json, published with everything else.

Use

Point any MCP client at the published catalog — or at the site root, and the filename is appended for you:

{
  "mcpServers": {
    "my-docs": {
      "command": "npx",
      "args": ["-y", "@stellayazilim/mcp-starlight", "https://example.com"]
    }
  }
}

Claude Code:

claude mcp add my-docs -- npx -y @stellayazilim/mcp-starlight https://example.com

While writing docs, point it at a local build instead:

npx @stellayazilim/mcp-starlight ./dist/mcp-catalog.json

Tools

Tool Answers
search_docs "Which page covers X?" — ranked matches with routes and descriptions
get_doc "Show me that page" — full Markdown
list_docs "What is in these docs?" — every page with title and description
search_reference Exact names and signatures from your structured data — only registered when you provide some

search_docs and list_docs take locale and version when your site has them, so an answer can be scoped to one language or one documentation line.

Options

starlightMcp({
  siteLabel: 'My Product',        // shown in tool descriptions
  versions: ['preview', 'v1'],    // route segments that denote a docs line
  exclude: ['api'],               // content directories to leave out
  filename: 'mcp-catalog.json',   // output name inside the build
  collections: { … },             // structured data — object or function
})

versions turns a path segment into a facet. With versions: ['preview'], /preview/guides/x is tagged preview and /guides/x is the default line, so a reader can ask about one without the other bleeding in.

exclude matches path prefixes after the locale and version segments are stripped, so exclude: ['api'] covers api/, tr/api/, preview/api/ and tr/preview/api/ in one entry instead of four.

locales need no configuration — they are read from the Astro i18n config that Starlight generates.

Structured collections

Prose search cannot answer "what is the exact signature of this type". If your build already produces that information — a generated API surface, a schema, a changelog — hand it over and it becomes searchable alongside the pages:

starlightMcp({
  collections: () => ({
    api: {
      label: '.NET API reference',
      entries: types.map((t) => ({
        id: t.uid,
        title: t.name,
        signature: t.declaration,
        summary: t.summary,
        route: t.docPath,
      })),
    },
  }),
})

Entries need id and title; signature, summary, detail and route are used when present. The integration knows nothing about where they came from — it publishes them, and search_reference appears.

Pass a function when the data is produced by another build step, so it is read at build time rather than when the config is loaded.

Why not the Pagefind index?

Starlight already builds one, and reusing it is a fair instinct. It is the wrong shape: Pagefind indexes rendered pages for browser-side search and ships a WASM runtime that returns HTML excerpts. This catalog is Markdown with frontmatter intact, plus whatever structured data you added — which is what a model can actually use, and what makes locale and version filtering possible.

Why a process at all?

MCP is JSON-RPC. A client POSTs a body and expects an answer computed from it; a static host returns the same bytes for every request and rejects POST outright. So something must run — but it does not have to be hosted. Here it runs where the reader is:

your static host                  the reader's machine
────────────────                  ────────────────────
mcp-catalog.json   ──GET──►       npx …mcp-starlight   ──stdio──►   Claude, Cursor, …

License

MIT

Recommended Servers

playwright-mcp

playwright-mcp

A Model Context Protocol server that enables LLMs to interact with web pages through structured accessibility snapshots without requiring vision models or screenshots.

Official
Featured
TypeScript
Audiense Insights MCP Server

Audiense Insights MCP Server

Enables interaction with Audiense Insights accounts via the Model Context Protocol, facilitating the extraction and analysis of marketing insights and audience data including demographics, behavior, and influencer engagement.

Official
Featured
Local
TypeScript
Magic Component Platform (MCP)

Magic Component Platform (MCP)

An AI-powered tool that generates modern UI components from natural language descriptions, integrating with popular IDEs to streamline UI development workflow.

Official
Featured
Local
TypeScript
VeyraX MCP

VeyraX MCP

Single MCP tool to connect all your favorite tools: Gmail, Calendar and 40 more.

Official
Featured
Local
graphlit-mcp-server

graphlit-mcp-server

The Model Context Protocol (MCP) Server enables integration between MCP clients and the Graphlit service. Ingest anything from Slack to Gmail to podcast feeds, in addition to web crawling, into a Graphlit project - and then retrieve relevant contents from the MCP client.

Official
Featured
TypeScript
Kagi MCP Server

Kagi MCP Server

An MCP server that integrates Kagi search capabilities with Claude AI, enabling Claude to perform real-time web searches when answering questions that require up-to-date information.

Official
Featured
Python
E2B

E2B

Using MCP to run code via e2b.

Official
Featured
Neon Database

Neon Database

MCP server for interacting with Neon Management API and databases

Official
Featured
Exa Search

Exa Search

A Model Context Protocol (MCP) server lets AI assistants like Claude use the Exa AI Search API for web searches. This setup allows AI models to get real-time web information in a safe and controlled way.

Official
Featured
Qdrant Server

Qdrant Server

This repository is an example of how to create a MCP server for Qdrant, a vector search engine.

Official
Featured