README Documentation
NyxDocs - Cryptocurrency Documentation MCP Server
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 criteriaget_project_info: Detailed project information with blockchain contextget_documentation: Retrieve actual documentation contentlist_blockchains: Available blockchain networkscheck_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
- MCP Server Core: FastMCP-based server handling protocol communication
- Data Collectors: Modules for gathering project information from various APIs
- Documentation Scrapers: Intelligent content extraction from different sources
- Database Layer: SQLite/PostgreSQL for storing projects and documentation
- 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
- Inspired by Context7 by Upstash
- Built with Python MCP SDK
- Cryptocurrency data provided by CoinGecko API
NyxDocs - Making cryptocurrency project documentation accessible and up-to-date for AI assistants.
Quick Install
Quick Actions
Key Features
Model Context Protocol
Secure Communication
Real-time Updates
Open Source