Integrate with MCP

Updated

Use an AI coding agent to integrate Agora products more efficiently. By configuring the Agora Doc MCP Server, your coding agent can directly search and read Agora official documentation before answering questions or generating code, so it can work with the latest official content and provide more accurate support.

Connect to the Agora Doc MCP Server

Choose one of the following ways to connect to the MCP server:

Trae

Manual configuration:

Add the following configuration manually in Trae under Settings > MCP:

{
  "mcpServers": {
    "shengwang-docs": {
      "type": "http",
      "url": "https://mcp.agora.io"
    }
  }
}

Claude Code

Add with the CLI:

claude mcp add --transport http shengwang-docs https://mcp.agora.io

Or configure it manually:

Create or edit .mcp.json in the project root, then add the following section:

{
  "mcpServers": {
    "shengwang-docs": {
      "type": "http",
      "url": "https://mcp.agora.io"
    }
  }
}

Codex

Add with the CLI:

codex mcp add shengwang-docs --url https://mcp.agora.io

Or configure it manually:

Create or edit .codex/config.toml in the project root, then add the following section:

[mcp_servers.shengwang-docs]
url = "https://mcp.agora.io"

Cursor

Manual configuration:

Create or edit .cursor/mcp.json in the project root, then add the following section:

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

Kiro

Manual configuration:

Create or edit .kiro/settings/mcp.json in the project root, then add the following section:

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

VS Code & Copilot

Add with the CLI:

code --add-mcp '{"name":"shengwang-docs","type":"http","url":"https://mcp.agora.io"}'

Or configure it manually:

Create or edit .vscode/mcp.json in the root directory, then add the following section:

{
  "servers": {
    "shengwang-docs": {
      "type": "http",
      "url": "https://mcp.agora.io"
    }
  }
}

MCP tools

  • search-docs: Search for relevant documentation.
  • list-docs: Browse documentation categories and document lists.
  • get-doc-content: Read the full content of a specified document.

Use MCP tools

Automatically called by the coding agent

In Agent Mode, you can describe your requirement directly and let the coding agent decide when to call MCP tools.

For example:

Search the relevant Agora documentation, read the document content, and tell me how to build the simplest possible 1v1 real-time audio and video call.

Specify tool calls in the prompt

You can also specify which MCP tools to use in the prompt through the tool-calling syntax supported by your AI IDE.

For example:

#search-docs #get-doc-content Use search-docs to find relevant Agora documentation, then use get-doc-content to read the full content of the matched document and tell me how to build an interactive experience with an AI agent.