Astro Docs

Provides structured Astro documentation access for AI assistants, including search and read capabilities.

javascript

3

GitHub Stars

javascript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "dreyfus92-astro-docs-mcp": {
      "command": "./bin/astro-docs-mcp",
      "args": []
    }
  }
}

You have an MCP server that enables AI assistants to access and reference Astro documentation. It exposes Astro docs via dedicated resources and provides tools to search and explain Astro topics, making it easier to help users with Astro-related tasks.

How to use

You interact with the Astro Docs MCP Server through an MCP client. You can list available documentation sections, search for topics, and read specific sections using the provided URIs. Use the built-in tools to locate relevant Astro information quickly and read sections directly in your client or integrated workflow.

How to install

Prerequisites you need before installation include Node.js version 16 or later and a preferred package manager. For best compatibility, Node.js 20+ is recommended.

Install dependencies using your package manager.

Build the server to compile TypeScript sources into runnable JavaScript.

Start the server using the generated launcher script.

Steps you can follow exactly:

pnpm install
pnpm run build
pnpm start
./bin/astro-docs-mcp

Configuration and usage notes

The server provides a launcher you can run directly. On your system, you can start it with the launcher script located under bin. The recommended start method is to run the launcher script to ensure proper environment setup and module loading.

If you are configuring an integration tool, use the absolute path to the launcher script to avoid path resolution issues.

Troubleshooting tips

Ensure the binary launcher has executable permissions. If you run into module or path errors, re-run the build process and verify you are executing from the correct directory. Check that you are using a supported Node.js version and that your environment contains the necessary dependencies.

Tools

The server exposes several tools to interact with Astro documentation.

Examples and recommended workflows

Example workflows you can perform with the MCP client include listing docs, searching for topics, and reading specific sections via their astro-docs:// URIs.

Available tools

search_docs

Search Astro documentation and return matching sections.

explain_astro_islands

Provide detailed explanations of Astro Islands architecture.

astro_project_setup

Guide for setting up a new Astro project.

astro_vs_other_frameworks

Compare Astro with other web frameworks.