NyxDocs - Cryptocurrency Documentation MCP Server

1# NyxDocs - Cryptocurrency Documentation MCP Server
2 
3[![Python](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
4[![MCP](https://img.shields.io/badge/MCP-compatible-green.svg)](https://modelcontextprotocol.io)
5[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
6 
7NyxDocs 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.
8 
9## 🚀 Features
10 
11### Core Capabilities
12- **Multi-Blockchain Support**: Ethereum, BSC, Polygon, Solana, and more
13- **Real-time Documentation**: Automatically discovers and updates project docs
14- **Smart Search**: Find projects by name, category, or blockchain
15- **Content Extraction**: Supports GitHub, GitBook, Notion, and official websites
16- **Update Monitoring**: Tracks documentation changes automatically
17 
18### MCP Tools
19- `search_crypto_projects`: Search cryptocurrency projects by various criteria
20- `get_project_info`: Detailed project information with blockchain context
21- `get_documentation`: Retrieve actual documentation content
22- `list_blockchains`: Available blockchain networks
23- `check_updates`: Recent documentation updates
24 
25## 🏗️ Architecture
26 
27```
28┌─────────────────┐    ┌──────────────────┐    ┌─────────────────┐
29│   Data Sources  │    │   NyxDocs Core   │    │   MCP Client    │
30│                 │    │                  │    │                 │
31│ • CoinGecko API │────│ • Project DB     │────│ • Claude        │
32│ • GitHub API    │    │ • Doc Scraper    │    │ • Cursor        │
33│ • GitBook       │    │ • Update Monitor │    │ • VS Code       │
34│ • Notion        │    │ • MCP Server     │    │ • Other Clients │
35└─────────────────┘    └──────────────────┘    └─────────────────┘
36```
37 
38### Key Components
39 
401. **MCP Server Core**: FastMCP-based server handling protocol communication
412. **Data Collectors**: Modules for gathering project information from various APIs
423. **Documentation Scrapers**: Intelligent content extraction from different sources
434. **Database Layer**: SQLite/PostgreSQL for storing projects and documentation
445. **Update Monitors**: Background tasks for tracking documentation changes
45 
46## 📦 Installation
47 
48### Prerequisites
49- Python 3.11+
50- uv (recommended) or pip
51 
52### Quick Start
53 
54```bash
55# Clone the repository
56git clone https://github.com/nyxn-ai/NyxDocs.git
57cd NyxDocs
58 
59# Install with uv (recommended)
60uv sync
61 
62# Or install with pip
63pip install -e .
64 
65# Set up environment
66cp .env.example .env
67# Edit .env with your API keys
68 
69# Initialize database
70uv run python -m nyxdocs.database.init
71 
72# Start the server
73uv run python -m nyxdocs.server
74```
75 
76### MCP Client Configuration
77 
78#### Cursor
79```json
80{
81  "mcpServers": {
82    "nyxdocs": {
83      "command": "uv",
84      "args": ["run", "python", "-m", "nyxdocs.server"]
85    }
86  }
87}
88```
89 
90#### Claude Desktop
91```json
92{
93  "mcpServers": {
94    "nyxdocs": {
95      "command": "uv",
96      "args": ["run", "python", "-m", "nyxdocs.server"]
97    }
98  }
99}
100```
101 
102## 🔧 Configuration
103 
104### Environment Variables
105 
106```env
107# API Keys
108COINGECKO_API_KEY=your_coingecko_api_key
109GITHUB_TOKEN=your_github_token
110 
111# Database
112DATABASE_URL=sqlite:///nyxdocs.db
113# Or for PostgreSQL: postgresql://user:pass@localhost/nyxdocs
114 
115# Server Settings
116LOG_LEVEL=INFO
117UPDATE_INTERVAL=3600  # seconds
118MAX_CONCURRENT_SCRAPES=5
119```
120 
121### Supported Data Sources
122 
123- **CoinGecko**: Market data and project information
124- **GitHub**: Repository documentation and README files
125- **GitBook**: Hosted documentation platforms
126- **Notion**: Project documentation pages
127- **Official Websites**: Direct documentation scraping
128 
129## 🛠️ Usage Examples
130 
131### Search for DeFi Projects
132```python
133# In your MCP client
134search_crypto_projects(query="uniswap", category="DeFi", blockchain="ethereum")
135```
136 
137### Get Project Documentation
138```python
139get_documentation(project="uniswap", format="markdown")
140```
141 
142### Monitor Updates
143```python
144check_updates(since="2024-01-01", limit=10)
145```
146 
147## 🧪 Development
148 
149### Project Structure
150```
151NyxDocs/
152├── nyxdocs/
153│   ├── __init__.py
154│   ├── server.py              # Main MCP server
155│   ├── collectors/            # Data collection modules
156│   ├── scrapers/              # Documentation scrapers
157│   ├── database/              # Database models and operations
158│   ├── tools/                 # MCP tool implementations
159│   └── utils/                 # Utility functions
160├── tests/                     # Test suite
161├── docs/                      # Documentation
162├── pyproject.toml            # Project configuration
163└── README.md
164```
165 
166### Running Tests
167```bash
168uv run pytest
169```
170 
171### Code Quality
172```bash
173uv run ruff check
174uv run mypy nyxdocs
175```
176 
177## 📚 Documentation
178 
179- [API Reference](docs/api.md)
180- [Configuration Guide](docs/configuration.md)
181- [Development Setup](docs/development.md)
182- [Contributing Guidelines](CONTRIBUTING.md)
183 
184## 🤝 Contributing
185 
186We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details.
187 
188## 📄 License
189 
190This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
191 
192## 🙏 Acknowledgments
193 
194- Inspired by [Context7](https://github.com/upstash/context7) by Upstash
195- Built with [Python MCP SDK](https://github.com/modelcontextprotocol/python-sdk)
196- Cryptocurrency data provided by CoinGecko API
197 
198---
199 
200**NyxDocs** - Making cryptocurrency project documentation accessible and up-to-date for AI assistants.
201