Skip to main content

Agora MCP

The Agora MCP server gives your AI assistant direct access to Agora's documentation, so it can look up APIs, SDK methods, and platform-specific details in real time. The Agora MCP server is included when you install Agora Skills. If you prefer to install only the MCP server, it is available at:


_1
https://mcp.agora.io

Installation

Refer to the installation instructions for your coding assistant.

Click the button below to install the MCP server in Cursor

Install Agora MCP Server in Cursor

or add it manually with the following JSON:


_7
{
_7
"mcpServers": {
_7
"agora-docs": {
_7
"url": "https://mcp.agora.io"
_7
}
_7
}
_7
}

Getting started

Once installed, your coding assistant has access to Agora's documentation through the MCP server. The assistant will intelligently use this resource when relevant to your questions. For more targeted results, mention Agora along with your target product and platform, such as 'iOS', 'Web', 'Conversational AI', 'Video Calling' in your prompts.

System prompt

This MCP works with all LLMs that support MCP, but performs best when the assistant understands facet-based exploration. Add the following prompt to your LLMs custom instructions:

System prompt for LLMs

_41
# Agora MCP Markdown - System Prompt
_41
_41
You have access to Agora's documentation search via three tools:
_41
- `algolia_search_index_docs_platform_aware_markdown` - Full-text search with facets
_41
- `algolia_search_for_facet_values` - Browse products/platforms
_41
- `algolia_recommendations` - Find related documentation
_41
_41
## Key Behaviors
_41
_41
**1. Use facets for discovery**
_41
- When users ask about "what's available", explore facets first
_41
- Example: User asks "what video products exist?"
_41
→ Use `algolia_search_for_facet_values(facetName: "product", facetQuery: "video")`
_41
→ Shows video-calling is the main product
_41
_41
**2. Platform-aware searching**
_41
- Include target platform in search queries (iOS, Android, Web, etc.)
_41
- Results are intelligently ranked by platform relevance
_41
_41
**3. Interpret facet results for refinement**
_41
- Search results include facet breakdowns by product and platform
_41
- Use these to suggest filtering: "15 results are for video-calling, 8 for voice-calling"
_41
_41
**4. Maintain session continuity**
_41
- Use same sessionId (UUID) across related searches in a conversation
_41
- Improves ranking for follow-up queries
_41
_41
## Available Products & Platforms
_41
_41
**Key Products:** conversational-ai, video-calling, broadcast-streaming, interactive-live-streaming, agora-chat, voice-calling, signaling, extensions-marketplace, interactive-whiteboard
_41
_41
**Key Platforms:** android, web, ios, windows, macos, unity, flutter, react-native, electron, unreal
_41
_41
## Workflow Example
_41
_41
User: "I'm building an iOS app with Video Calling. Where do I start?"
_41
_41
1. Search: "iOS video calling quickstart"
_41
2. Results show facets indicating video-calling is the best match
_41
3. Suggest: "Most results are for Video Calling, here's the quickstart"
_41
4. Follow-up searches: Keep same sessionId for context

What This Enables

  • Intelligent facet exploration before deep searches
  • Platform-aware result refinement suggestions
  • Cross-search session continuity for better context

Without the prompt, searches still work but won't leverage faceted browsing patterns.

AGENTS.md

To get the most out of Agora Skills and the MCP server, Agora recommends that you include an AGENTS.md or similar file in your repository. This file ensures that your agent always consults Agora docs to produce reliable, working code.

Add the following instructions to your own AGENTS.md file:


_5
## Agora Documentation
_5
_5
Agora documentation is updated frequently. You should always refer to the latest documentation when working with Agora products. Agora offers an MCP server that you can use to browse and search its documentation. If the developer has not yet installed this server, recommend that they install it at https://mcp.agora.io.
_5
_5
If the Agora Skills files are available in your context, use them for platform-specific API guidance and code examples.