mcp-agora-docs-unofficial
v1.0.0
Published
MCP server providing comprehensive Agora RTC documentation (1,993 docs) - Video/Voice Calling, Live Streaming, Signaling
Maintainers
Readme
MCP Agora Documentation Server (Unofficial)
Note: This is an unofficial community project. For official Agora support, visit docs.agora.io
Complete Agora RTC documentation (1,993 documents) accessible through the Model Context Protocol (MCP) for AI-powered development with Claude and other AI assistants.
What's Included
This MCP server provides instant access to the entire Agora documentation library:
- 1,993 documentation files across all platforms and features
- 5 product categories: Video Calling, Voice Calling, Interactive Live Streaming, Broadcast Streaming, Signaling
- 14 platform SDKs: Android, iOS, Web, Windows, macOS, Unity, React Native, Flutter, Electron, Unreal Engine, Blueprint, React.js, Linux C++, Python
- 100+ advanced features with platform-specific implementations
- Last updated: 2026-01-22
Why Use This?
When building RTC applications with AI assistance, you need accurate, up-to-date documentation. This MCP server gives Claude (and other AI tools) direct access to:
- Platform-specific SDK documentation
- Code examples and quickstart guides
- API references and method signatures
- Best practices and troubleshooting guides
- Configuration parameters and limits
- Feature availability across platforms
Installation
npm install -g mcp-agora-docs-unofficialSetup
Claude Desktop
Add to your Claude Desktop MCP configuration file:
macOS/Linux: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"agora-docs": {
"command": "mcp-agora-docs-unofficial"
}
}
}Restart Claude Desktop, and you'll see the Agora docs server connected.
Other MCP Clients
Any MCP-compatible client can use this server. Run the server:
mcp-agora-docs-unofficialThe server communicates via stdio following the MCP protocol.
MCP Tools & Resources
This server provides 2 MCP Tools and Resources for browsing:
MCP Tools
1. search_rtc_docs
Search across all 1,993 Agora documents by keyword, SDK method, platform, or feature.
Parameters:
query(required): Search keywords (e.g., "join channel", "configure video encoding")provider(optional): Filter by provider (currently "agora")category(optional): Filter by category (video-calling, voice-calling, broadcast-streaming, etc.)limit(optional): Maximum results (default: 10)
Example Usage:
Query: "How do I enable AI noise suppression on Android?"
→ Returns platform-specific docs with code examplesReturns:
- Document title
- Provider and category
- Relevance score
- Source URL
- Resource URI for full document
- Excerpt with highlighted matches
2. list_providers
Get metadata about available RTC providers and their documentation.
Parameters: None
Returns:
- Provider name and ID
- Document count
- Browse URI
- Categories available
Example Output:
Agora
- ID: agora
- Documents: 1,993
- Categories: video-calling, voice-calling, broadcast-streaming, interactive-live-streaming, signaling
- Last Updated: 2026-01-22MCP Resources
Browse documentation hierarchically using resource URIs:
rtc-docs:///agora # Provider root
rtc-docs:///agora/video-calling # Category
rtc-docs:///agora/video-calling/get-started # Section
rtc-docs:///agora/video-calling/get-started/get-started-sdk_android # Specific documentResource Features:
- Hierarchical navigation
- Markdown content delivery
- Category listing
- Document metadata
Use Cases
Example Queries
Platform-Specific Implementation:
"Show me how to implement virtual background on iOS"
→ Returns ios-specific virtual-background documentationMulti-Platform Comparison:
"What's the difference between Android and Web screen sharing?"
→ Returns both platform docs for comparisonConfiguration Help:
"What are the recommended video encoding settings for 720p at 30fps?"
→ Returns configure-video-encoding docs with parametersTroubleshooting:
"Why am I getting error code 17 when joining a channel?"
→ Returns error code reference and connection troubleshootingFeature Availability:
"Does Unity support AI noise suppression?"
→ Returns Unity-specific advanced features documentationDocumentation Coverage
Product Categories (5)
| Category | Documents | Description | |----------|-----------|-------------| | Video Calling | 470 | 1:1 and group video calls with HD quality | | Voice Calling | 357 | Audio-only communication | | Interactive Live Streaming | 466 | Low-latency interactive broadcasts | | Broadcast Streaming | 467 | Large-scale streaming to audiences | | Signaling | 233 | Real-time messaging and metadata sync |
Platform Support (14)
Tier 1 - Full Support (200+ docs each):
- Android, iOS, Web, macOS, Windows
Tier 2 - Extended Support (90-180 docs each):
- Unity, React Native, Flutter, Electron, Unreal Engine
Tier 3 - Limited Support:
- React.js, Blueprint, Linux C++, Python
Feature Categories
Each product category includes:
- Get Started: SDK setup, quickstart guides, sample projects
- API Reference: Complete SDK and REST API documentation
- Advanced Features: 100+ features (virtual background, screen sharing, AI noise suppression, etc.)
- Enhance Call Quality: Video/audio encoding, connection management, quality monitoring
- Best Practices: Implementation patterns, optimization guides
- Troubleshooting: Error codes, debugging, platform-specific issues
- Security: Token authentication, encryption, compliance
- Channel Management: REST APIs for server-side operations
Package Details
- Package Size: ~30MB (includes all 1,993 markdown documents)
- Node Version: >= 18.0.0
- Dependencies: Minimal (MCP SDK, search engine, file system utilities)
- License: MIT
Performance
- Search: Fast full-text search across all documents (~50ms average)
- Indexing: Automatic on first run (one-time ~2-3 seconds)
- Memory: ~100MB RAM footprint
- Storage: ~30MB disk space
Development
Local Development
# Clone repository
git clone https://github.com/yourusername/mcp-agora-docs-unofficial.git
cd mcp-agora-docs-unofficial
# Install dependencies
npm install
# Build TypeScript
npm run build
# Test locally
npm run devProject Structure
mcp-agora-docs-unofficial/
├── src/
│ ├── server/ # MCP server implementation
│ ├── search/ # Document search engine
│ ├── storage/ # Document management
│ └── utils/ # Utilities
├── data/
│ └── docs/agora/ # 1,993 Agora documentation files
├── dist/ # Compiled JavaScript (generated)
└── package.jsonRelated Resources
- Agora Official Docs: https://docs.agora.io
- Agora Spec: See AGORA_SPEC.md for complete feature matrix
- Model Context Protocol: https://modelcontextprotocol.io
- Claude Desktop: https://claude.ai/download
Roadmap
Future enhancements:
- [ ] Code repository examples (GitHub demo repos)
- [ ] Additional RTC providers (Tencent, LiveKit, Zoom)
- [ ] Automatic documentation updates
- [ ] Multi-language support (currently English only)
Contributing
Contributions are welcome! Please open an issue or PR.
License
MIT License - see LICENSE file for details.
Support
- Issues: https://github.com/yourusername/mcp-agora-docs-unofficial/issues
- Agora Support: [email protected]
- MCP Discord: https://discord.gg/mcp
Built for the AI-powered development era 🤖
Made with ❤️ for developers building real-time communication apps with AI assistance.
