Our documentation exposes a Model Context Protocol (MCP) server. Connect it to an MCP-capable AI assistant (Cursor, Claude Code, Claude Desktop, VS Code, Codex CLI, ChatGPT) and the assistant can search our guides and API reference and answer questions using current, authoritative content.
We publish two endpoints. Choose based on whether you have an account for our documentation portal.
| Endpoint | URL | Authentication | Content served |
|---|---|---|---|
| Public | https://docs.upvest.co/mcp-public | No credentials required | Public documentation only. |
| Authenticated | https://docs.upvest.co/mcp | Required — sign in when your client prompts you | Everything your account is entitled to see, including custom client content. |
Opening either URL in a browser shows a setup page with copy-ready connection snippets. The two pages link to each other.
Both endpoints use the streamable HTTP transport. Use the authenticated endpoint if you have a portal login; use the public endpoint if you do not, or if your client cannot complete a browser sign-in flow.
Replace <URL> with the endpoint you chose from the table above.
Open MCP settings
Open the command palette (Cmd+Shift+P on macOS, Ctrl+Shift+P on Windows/Linux) and run Open MCP settings.
Add a custom MCP server
Select Add custom MCP. Cursor opens mcp.json.
Add the server and save
Add the server and save:
{
"mcpServers": {
"upvest-docs": {
"url": "<URL>"
}
}
}Sign in to finish
Return to MCP settings. If prompted, select Needs login and complete sign-in. Cursor then lists the available tools.
claude mcp add --transport http upvest-docs <URL>Type /mcp in the CLI and complete authentication if prompted.
Open the connector settings
Go to Customize → Connectors → Add custom connector.
Add the endpoint
Paste <URL> and click Add.
Sign in to finish
Sign in if prompted.
Add an MCP server
Open the command palette and run MCP: Add Server.
Configure the connection
Select HTTP, enter <URL>, and name the connection.
Sign in to finish
If prompted, complete sign-in in the browser.
Confirm the tools appear
In Chat (Agent mode), select the Tools icon to confirm the server and its tools appear.
codex mcp add upvest-docs --url <URL>
codex mcp login upvest-docs # authenticated endpoint only
codex mcp listOpen the MCP settings
Go to Settings → Plugins → MCPs.
Add the server
Add a server of type Streamable HTTP with <URL>.
Restart the app
Restart the app.
In your assistant's chat (agent mode where applicable), ask a question that requires our documentation, for example: "Which endpoint creates an order, and what fields are required?"
The assistant should call a tool from the upvest-docs server before answering.
Agents can discover the server without manual configuration through the MCP server card:
GET https://docs.upvest.co/.well-known/mcp/server-card.jsonThe card lists the transport endpoint, capabilities, authentication requirements, and available tools.
| Symptom | Cause | Fix |
|---|---|---|
401 Unauthorized from /mcp | You are not signed in | Complete the sign-in flow in your client, or switch to /mcp-public (the 401 response body includes the URL). |
403 Forbidden from /mcp | Your account does not have MCP access | Contact your Upvest representative. |
| Tools appear but answers omit content you can see in the portal | AI agent is connected to /mcp-public | Reconnect using /mcp and sign in. |
| AI agent cannot open a browser for sign-in | Headless or restricted environment | Use /mcp-public, or pass an Authorization header in the client configuration where supported. |