mirror of
https://github.com/tiennm99/DocsGPT.git
synced 2026-10-12 20:15:26 +00:00
arc53-machine
bfcc4a9773
Notion, Linear, Atlassian, Sentry, Asana and Stripe no longer open the MCP server form. The wizard shows one "Sign in to Notion" button: the pop-up opens inside the click (so browsers allow it), follows the worker's mcp.oauth events to the provider, and the tool is saved on success with its actions on the done step. Reconnecting a preset uses the same flow, as do the chat bar and the health toast. Saving an OAuth MCP server without a new handshake now uses the stored sign-in instead of failing, and the custom MCP form keeps scopes and timeout under Show advanced.
69 lines
2.9 KiB
Plaintext
69 lines
2.9 KiB
Plaintext
---
|
|
title: MCP Tool Integration
|
|
description: Connect external tools to DocsGPT agents using the Model Context Protocol (MCP) standard.
|
|
---
|
|
|
|
import { Callout } from 'nextra/components'
|
|
import { Steps } from 'nextra/components'
|
|
|
|
# MCP Tool Integration
|
|
|
|
The [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) integration lets you connect external tool servers to DocsGPT. Your agents can then discover and call tools provided by those servers during conversations — for example, querying a CRM, running code, or accessing a database.
|
|
|
|
## Setup
|
|
|
|
<Steps>
|
|
|
|
### Step 1: Configure Environment Variables (Optional)
|
|
|
|
Only needed if your MCP servers use OAuth authentication:
|
|
|
|
```env
|
|
MCP_OAUTH_REDIRECT_URI=https://yourdomain.com/api/mcp_server/callback
|
|
```
|
|
|
|
If not set, it is derived from the host of `CONNECTOR_REDIRECT_BASE_URI`, then from `API_URL`.
|
|
|
|
### Step 2: Add an MCP Server
|
|
|
|
Go to **Settings** > **Connectors** and pick a preset (Notion, Linear, Atlassian, Sentry, Asana, Stripe): **Sign in to Notion** opens the service's sign-in, and its tools are ready when you come back. For any other server, choose **Add custom connector** > **MCP server** and enter its URL and authentication; scopes and the timeout are under **Show advanced**. Enter the server URL, select an auth type, and click **Test Connection** to verify, then **Save**.
|
|
|
|
### Step 3: Enable for Your Agent
|
|
|
|
In your agent configuration, enable the MCP tools you want the agent to use.
|
|
|
|
</Steps>
|
|
|
|
Presets need no URL or form: they sign in with OAuth in one step. Admins can turn presets off one by one, and turn off custom MCP servers, in **Admin > Connectors**. See [Connectors](/Guides/Connectors).
|
|
|
|
## Authentication Types
|
|
|
|
| Auth Type | Config Fields |
|
|
|-----------|---------------|
|
|
| **None** | — |
|
|
| **Bearer** | `bearer_token` |
|
|
| **API Key** | `api_key`, `api_key_header` (default: `X-API-Key`) |
|
|
| **Basic** | `username`, `password` |
|
|
| **OAuth** | `oauth_scopes` (optional) |
|
|
|
|
<Callout type="warning">
|
|
For OAuth in production, `MCP_OAUTH_REDIRECT_URI` must be a publicly accessible URL pointing to your DocsGPT backend.
|
|
</Callout>
|
|
|
|
## API Endpoints
|
|
|
|
| Endpoint | Method | Description |
|
|
|----------|--------|-------------|
|
|
| `/api/mcp_server/test` | POST | Test a connection without saving |
|
|
| `/api/mcp_server/save` | POST | Save or update a server configuration |
|
|
| `/api/mcp_server/callback` | GET | OAuth callback handler |
|
|
| `/api/mcp_server/oauth_status/<task_id>` | GET | Poll OAuth flow status |
|
|
| `/api/mcp_server/auth_status` | GET | Batch check auth status for all MCP tools |
|
|
|
|
## Troubleshooting
|
|
|
|
- **Connection refused** — Verify the URL and that the server is reachable from your backend.
|
|
- **403 Forbidden** — Check credentials and permissions.
|
|
- **Timed out** — Default is 30s; increase timeout in tool config (max 300s).
|
|
- **OAuth "needs_auth" persists** — Verify `MCP_OAUTH_REDIRECT_URI` is correct and Redis is running.
|