NyxDocs

Specialized MCP server for cryptocurrency project documentation management with multi-blockchain support (Ethereum, BSC, Polygon, Solana).

Updated 3 weeks ago
Added Jun 22, 2025

Docs & Usage Guide

NyxDocs - Cryptocurrency Documentation MCP Server

Python MCP License

NyxDocs is a specialized Model Context Protocol (MCP) server that provides comprehensive documentation management for cryptocurrency projects. Built with Python and inspired by Context7's architecture, it offers real-time access to crypto project documentation, blockchain information, and development resources.

πŸš€ Features

Core Capabilities

  • Multi-Blockchain Support: Ethereum, BSC, Polygon, Solana, and more
  • Real-time Documentation: Automatically discovers and updates project docs
  • Smart Search: Find projects by name, category, or blockchain
  • Content Extraction: Supports GitHub, GitBook, Notion, and official websites
  • Update Monitoring: Tracks documentation changes automatically

MCP Tools

  • search_crypto_projects: Search cryptocurrency projects by various criteria
  • get_project_info: Detailed project information with blockchain context
  • get_documentation: Retrieve actual documentation content
  • list_blockchains: Available blockchain networks
  • check_updates: Recent documentation updates

πŸ—οΈ Architecture

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”    β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”    β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚   Data Sources  β”‚    β”‚   NyxDocs Core   β”‚    β”‚   MCP Client    β”‚
β”‚                 β”‚    β”‚                  β”‚    β”‚                 β”‚
β”‚ β€’ CoinGecko API │────│ β€’ Project DB     │────│ β€’ Claude        β”‚
β”‚ β€’ GitHub API    β”‚    β”‚ β€’ Doc Scraper    β”‚    β”‚ β€’ Cursor        β”‚
β”‚ β€’ GitBook       β”‚    β”‚ β€’ Update Monitor β”‚    β”‚ β€’ VS Code       β”‚
β”‚ β€’ Notion        β”‚    β”‚ β€’ MCP Server     β”‚    β”‚ β€’ Other Clients β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜    β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜    β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

Key Components

  1. MCP Server Core: FastMCP-based server handling protocol communication
  2. Data Collectors: Modules for gathering project information from various APIs
  3. Documentation Scrapers: Intelligent content extraction from different sources
  4. Database Layer: SQLite/PostgreSQL for storing projects and documentation
  5. Update Monitors: Background tasks for tracking documentation changes

πŸ“¦ Installation

Prerequisites

  • Python 3.11+
  • uv (recommended) or pip

Quick Start

# Clone the repository
git clone https://github.com/nyxn-ai/NyxDocs.git
cd NyxDocs

# Install with uv (recommended)
uv sync

# Or install with pip
pip install -e .

# Set up environment
cp .env.example .env
# Edit .env with your API keys

# Initialize database
uv run python -m nyxdocs.database.init

# Start the server
uv run python -m nyxdocs.server

MCP Client Configuration

Cursor

{
  "mcpServers": {
    "nyxdocs": {
      "command": "uv",
      "args": ["run", "python", "-m", "nyxdocs.server"]
    }
  }
}

Claude Desktop

{
  "mcpServers": {
    "nyxdocs": {
      "command": "uv",
      "args": ["run", "python", "-m", "nyxdocs.server"]
    }
  }
}

πŸ”§ Configuration

Environment Variables

# API Keys
COINGECKO_API_KEY=your_coingecko_api_key
GITHUB_TOKEN=your_github_token

# Database
DATABASE_URL=sqlite:///nyxdocs.db
# Or for PostgreSQL: postgresql://user:pass@localhost/nyxdocs

# Server Settings
LOG_LEVEL=INFO
UPDATE_INTERVAL=3600  # seconds
MAX_CONCURRENT_SCRAPES=5

Supported Data Sources

  • CoinGecko: Market data and project information
  • GitHub: Repository documentation and README files
  • GitBook: Hosted documentation platforms
  • Notion: Project documentation pages
  • Official Websites: Direct documentation scraping

πŸ› οΈ Usage Examples

Search for DeFi Projects

# In your MCP client
search_crypto_projects(query="uniswap", category="DeFi", blockchain="ethereum")

Get Project Documentation

get_documentation(project="uniswap", format="markdown")

Monitor Updates

check_updates(since="2024-01-01", limit=10)

πŸ§ͺ Development

Project Structure

NyxDocs/
β”œβ”€β”€ nyxdocs/
β”‚   β”œβ”€β”€ __init__.py
β”‚   β”œβ”€β”€ server.py              # Main MCP server
β”‚   β”œβ”€β”€ collectors/            # Data collection modules
β”‚   β”œβ”€β”€ scrapers/              # Documentation scrapers
β”‚   β”œβ”€β”€ database/              # Database models and operations
β”‚   β”œβ”€β”€ tools/                 # MCP tool implementations
β”‚   └── utils/                 # Utility functions
β”œβ”€β”€ tests/                     # Test suite
β”œβ”€β”€ docs/                      # Documentation
β”œβ”€β”€ pyproject.toml            # Project configuration
└── README.md

Running Tests

uv run pytest

Code Quality

uv run ruff check
uv run mypy nyxdocs

πŸ“š Documentation

🀝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

πŸ“„ License

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

πŸ™ Acknowledgments


NyxDocs - Making cryptocurrency project documentation accessible and up-to-date for AI assistants.

Privacy Policy   16.80ms  0.94MB