MCP HubMCP Hub
mahawi1992

mcp-documentation-server

by: mahawi1992

MCP Documentation Server with AI Learning Capabilities

9created 04/12/2024
Visit
AI
Documentation

📌Overview

Purpose: To provide a smart documentation server that enhances code quality and manages documentation through AI integration.

Overview: The MCP Documentation Server is an AI-assisted platform integrated with Claude Desktop, designed to facilitate effective documentation management and code analysis across several programming frameworks.

Key Features:

  • AI Documentation Guide: Continuously maintains and updates an extensive knowledge base for documentation, ensuring it is current and relevant.

  • AI Code Assistant: Analyzes code to identify areas for improvement, enhancing code quality and best practices.

  • Framework Support: Offers compatibility with popular frameworks, including React.js, Next.js, Python, Vue.js, Angular, and Node.js, allowing for broad application in various development environments.

  • Brave Search Integration: Enables intelligent search capabilities, streamlining the retrieval of documentation and resources.

  • Learning System: Adapts and enhances its suggestions over time, improving efficiency and accuracy in documentation and code assistance.

MCP Documentation Server

A smart documentation server that provides AI-assisted code improvement and documentation management through Claude Desktop integration.

Features

  • AI Documentation Guide: Maintains and updates documentation knowledge base
  • AI Code Assistant: Analyzes and improves code quality
  • Framework Support:
    • React.js
    • Next.js (with App Router)
    • Python
    • Vue.js
    • Angular
    • Node.js
  • Brave Search Integration: Smart documentation search and retrieval
  • Learning System: Improves suggestions over time

Quick Start

  1. Install the package:
npm install -g mcp-documentation-server
  1. Configure Claude Desktop (config.json):
{
  "mcpServers": {
    "documentation": {
      "command": "npx",
      "args": ["-y", "mcp-documentation-server"],
      "env": {
        "BRAVE_API_KEY": "<YOUR_BRAVE_API_KEY>"
      }
    }
  }
}
  1. Start using with Claude:
Claude, search documentation for Next.js App Router

For detailed setup instructions, see Claude Desktop Setup Guide.

Development Setup

  1. Clone the repository:
git clone https://github.com/mahawi1992/mcp-documentation-server.git
cd mcp-documentation-server
  1. Install dependencies:
npm install
  1. Create a .env file:
PORT=3000
UPDATE_INTERVAL=3600000
CACHE_DURATION=86400000
BRAVE_API_KEY=your_brave_api_key
  1. Start the development server:
npm run dev

Documentation

  • Usage Guide
  • Claude Desktop Setup
  • API Documentation
  • Contributing Guide

Using with Claude Desktop

Basic Commands

Claude, search documentation for React hooks

Claude, analyze this Python code and suggest improvements...

Claude, find best practices for Next.js App Router

Advanced Usage

Claude, search for documentation about async/await in Python 3.9

Claude, analyze this code for security issues and suggest fixes...

For more examples, see the Usage Guide.

Contributing

  1. Fork the repository
  2. Create your feature branch: 
    git checkout -b feature/amazing-feature
  3. Commit your changes: 
    git commit -m 'Add amazing feature'
  4. Push to the branch: 
    git push origin feature/amazing-feature
  5. Open a Pull Request

Testing

Run the test suite:

npm test

Run specific tests:

npm test -- tests/integration/BraveSearchIntegration.test.ts

License

This project is licensed under the MIT License - see the LICENSE file for details.