Skip to content

mahawi1992/mcp-documentation-server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

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

About

MCP Documentation Server with AI Learning Capabilities

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published