Astro Docs

🚀 Astro Docs MCP Server

This is an MCP server that provides AI agents access to Astro documentation. The server allows AI assistants to search and reference Astro-related documents to assist users in completing Astro-related tasks.

This TypeScript-based MCP server implements a system for retrieving Astro documentation. It demonstrates core MCP concepts in the following ways:

• Representing parts of Astro documentation using astro-docs:// URIs and metadata
• Offering tools for searching Astro documentation
• Providing tips for common Astro questions and tasks

✨ Features

Resources

• List and access various sections in Astro documentation.
• Each documentation section has a title, content, and category.
• Provide simple content access using the plain text MIME type.

Tools

• search_docs - Search Astro documentation.
  • Accept a search query as a required parameter.
  • Return matching documentation sections.

Prompts

• explain_astro_islands - Get a detailed explanation of the Astro Islands architecture.
• astro_project_setup - Guide for creating a new Astro project.
• astro_vs_other_frameworks - Compare Astro with other web frameworks.

📁 Project Structure

• src/ - Server source code
  • index.ts - Main MCP server implementation
  • scripts/ - Scripts for auxiliary building and testing
    • build.js - Build script for transpiling TypeScript and generating startup scripts
    • test-client.js - Test client for verifying server functionality
• bin/ - Generated executable scripts
  • astro-docs-mcp - Main startup script
• build/ - Compiled JavaScript files (automatically generated)

📋 Configuration Requirements

• Requires Node.js v16 or higher.
• Node.js v20+ is recommended for optimal compatibility.
• The server uses ES module syntax.
• Example configuration file: config.json

📦 Installation and Configuration

Installation Steps

1. Clone this repository to your local machine:

   git clone https://github.com/yourusername/astro-docs-mcp.git
   cd astro-docs-mcp
   

2. Install dependencies:

   pnpm install
   

3. Start the server:

   npm start
   

Configuration Example

{
  "mcp_server": {
    "port": 3000,
    "documentation_path": "./docs",
    "logging": {
      "level": "info",
      "enabled": true
    }
  }
}

💻 Usage Examples

Basic Commands

1. List available documentation sections:

   npm run list
   

2. Search documentation content:

   npm run search <query>
   

3. View specific documentation:

   npm run read astro-docs:///<id>
   

🛠️ Troubleshooting

1. Port conflict: If the default port 3000 is occupied, try running on another port:

   npm start -- --port=3001
   

2. Dependency issues: Ensure all dependencies are correctly installed:

   pnpm install
   

3. Log output: Check if logging is enabled in config.json:

   "logging": {
     "level": "debug",
     "enabled": true
   }
   

🔮 Future Improvements

• Implement real-time retrieval of documentation from the official Astro website.
• Add more detailed documentation sections.
• Support documentation version control.
• Include code examples and snippets for common Astro patterns.