docs-mcp

docs-mcp

A secure MCP server providing intelligent documentation search across multiple frameworks using ChromaDB vector storage, enabling semantic search and integration with AI tools.

Category
访问服务器

README

docs-mcp

CI Tests Coverage Python 3.8+ License: MIT Code style: black

A secure Model Context Protocol (MCP) server providing intelligent documentation search across multiple frameworks using ChromaDB vector storage.

Features

  • Semantic Search across documentation using vector embeddings
  • Multiple Frameworks supported: Python, FastAPI, React, SwiftUI, Tailwind CSS, Figma API, Figma Plugins, MDN CSS
  • ChromaDB Storage for fast, persistent vector search
  • MCP Protocol integration for Claude Code and other AI tools
  • CLI Interface for easy management and extraction

Quick Start

  1. Setup Environment

    ./docs-mcp dev --setup
    
  2. Extract Documentation (choose one or more)

    ./docs-mcp extract --framework python
    ./docs-mcp extract --framework css
    ./docs-mcp extract --all
    
  3. Start MCP Server

    ./docs-mcp server --start
    
  4. Test Integration

    ./docs-mcp test --framework figma
    

Available Commands

Extract Documentation

./docs-mcp extract --framework python     # Python official docs
./docs-mcp extract --framework fastapi    # FastAPI documentation  
./docs-mcp extract --framework react      # React.js documentation
./docs-mcp extract --framework swiftui    # SwiftUI Apple docs
./docs-mcp extract --framework tailwind   # Tailwind CSS docs
./docs-mcp extract --framework figma      # Figma REST API docs
./docs-mcp extract --framework figma_plugin # Figma Plugin API docs
./docs-mcp extract --framework css        # MDN CSS documentation
./docs-mcp extract --all                  # Extract all frameworks

Analyze Collection

./docs-mcp analyze --stats                # Show documentation statistics

Test Integrations

./docs-mcp test --framework figma         # Test Figma integration
./docs-mcp test --all                     # Run all tests

Server Operations

./docs-mcp server --start                 # Start MCP server
./docs-mcp server --config               # Show configuration

Development

./docs-mcp dev --setup                    # Setup development environment
./docs-mcp dev --clean                    # Clean temporary files

Configuration

Set environment variables in .env:

CHROMA_DATA_DIR=/path/to/chroma/data
OPENAI_API_KEY=your_openai_key
ENVIRONMENT=development
MCP_SERVER_HOST=127.0.0.1
MCP_SERVER_PORT=8000

MCP Integration

Add to your .mcp.json:

{
  "mcpServers": {
    "docs": {
      "command": "python",
      "args": ["src/docs_mcp/server.py"],
      "env": {
        "PYTHONPATH": "src"
      }
    }
  }
}

Available MCP Tools

  • search_fastapi_docs() - Search FastAPI documentation
  • search_python_docs() - Search Python documentation
  • search_swift_ios_docs() - Search Swift/iOS documentation
  • get_security_guidelines() - Get security best practices
  • get_collection_stats() - View database statistics
  • add_project_documentation() - Add custom documentation

Framework Coverage

Framework Documents Status
Python 465+ ✅ Complete
Tailwind CSS 195+ ✅ Complete
Figma API 144+ ✅ Complete
Figma Plugins 60+ ✅ Complete
SwiftUI 39+ ✅ Complete
FastAPI 21+ ✅ Complete
React 15+ ✅ Complete
CSS (MDN) 2,400+ 🔄 In Progress

Requirements

  • Python 3.8+
  • OpenAI API key (for embeddings)
  • 2GB+ disk space (for ChromaDB)

License

MIT License - see LICENSE file for details.

Testing

This project maintains high test coverage with organized test suites:

  • Server Initialization Tests (4 tests): Verify server startup and imports
  • Configuration Tests (7 tests): Validate settings and environment handling
  • Tool Registration Tests (9 tests): Ensure all MCP tools are properly registered
  • CLI Tests (4 tests): Test command-line interface functionality

Running Tests Locally

# Run all tests
make test

# Run specific test categories
python -m pytest tests/test_server_initialization.py -v
python -m pytest tests/test_configuration.py -v
python -m pytest tests/test_tool_registration.py -v
python -m pytest tests/test_cli.py -v

# Run with coverage
python -m pytest tests/ --cov=src/docs_mcp --cov-report=html

Coverage Requirements

  • Minimum Coverage: 75%
  • Coverage Reports: Generated automatically in CI/CD
  • Coverage Artifacts: Available in GitHub Actions builds
  • PR Comments: Automatic coverage reporting on pull requests

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Run tests and ensure coverage: make test
  5. Submit a pull request

All pull requests must pass:

  • ✅ Server initialization tests
  • ✅ Configuration validation tests
  • ✅ Tool registration tests
  • ✅ CLI functionality tests
  • ✅ Code formatting (Black)
  • ✅ Code linting (flake8)
  • ✅ 75%+ test coverage

Support

For issues and questions, please open an issue on GitHub.

推荐服务器

Baidu Map

Baidu Map

百度地图核心API现已全面兼容MCP协议,是国内首家兼容MCP协议的地图服务商。

官方
精选
JavaScript
Playwright MCP Server

Playwright MCP Server

一个模型上下文协议服务器,它使大型语言模型能够通过结构化的可访问性快照与网页进行交互,而无需视觉模型或屏幕截图。

官方
精选
TypeScript
Magic Component Platform (MCP)

Magic Component Platform (MCP)

一个由人工智能驱动的工具,可以从自然语言描述生成现代化的用户界面组件,并与流行的集成开发环境(IDE)集成,从而简化用户界面开发流程。

官方
精选
本地
TypeScript
Audiense Insights MCP Server

Audiense Insights MCP Server

通过模型上下文协议启用与 Audiense Insights 账户的交互,从而促进营销洞察和受众数据的提取和分析,包括人口统计信息、行为和影响者互动。

官方
精选
本地
TypeScript
VeyraX

VeyraX

一个单一的 MCP 工具,连接你所有喜爱的工具:Gmail、日历以及其他 40 多个工具。

官方
精选
本地
graphlit-mcp-server

graphlit-mcp-server

模型上下文协议 (MCP) 服务器实现了 MCP 客户端与 Graphlit 服务之间的集成。 除了网络爬取之外,还可以将任何内容(从 Slack 到 Gmail 再到播客订阅源)导入到 Graphlit 项目中,然后从 MCP 客户端检索相关内容。

官方
精选
TypeScript
Kagi MCP Server

Kagi MCP Server

一个 MCP 服务器,集成了 Kagi 搜索功能和 Claude AI,使 Claude 能够在回答需要最新信息的问题时执行实时网络搜索。

官方
精选
Python
e2b-mcp-server

e2b-mcp-server

使用 MCP 通过 e2b 运行代码。

官方
精选
Neon MCP Server

Neon MCP Server

用于与 Neon 管理 API 和数据库交互的 MCP 服务器

官方
精选
Exa MCP Server

Exa MCP Server

模型上下文协议(MCP)服务器允许像 Claude 这样的 AI 助手使用 Exa AI 搜索 API 进行网络搜索。这种设置允许 AI 模型以安全和受控的方式获取实时的网络信息。

官方
精选