{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition","Steps","Step"]},"type":"markdown"},"seo":{"title":"Access the documentation MCP server","description":"Welcome to the Upvest API documentation. Here you will find all the information you need to integrate with our API.","siteUrl":"https://docs.upvest.co","image":"/assets/upvest-logo-card.ee25ccc59849324b0b73151a5c972c87639419556344db0b6dcf518151cb4c3c.925ff8b2.png","keywords":"documentation, api","lang":"en-US","meta":[{"name":"description","content":"Welcome to the Upvest API documentation. Here you will find all the information you need to integrate with our API."},{"name":"image","content":"/assets/upvest-logo-card.ee25ccc59849324b0b73151a5c972c87639419556344db0b6dcf518151cb4c3c.925ff8b2.png"},{"name":"twitter:card","content":"summary_large_image"},{"name":"twitter:title","content":"Welcome to the Upvest API Documentation"},{"name":"twitter:image","content":"/assets/upvest-logo-card.ee25ccc59849324b0b73151a5c972c87639419556344db0b6dcf518151cb4c3c.925ff8b2.png"},{"name":"twitter:description","content":"Welcome to the Upvest API documentation. Here you will find all the information you need to integrate with our API."},{"name":"og:url","content":"https://docs.upvest.co/"},{"name":"og:title","content":"Welcome to the Upvest API Documentation"},{"name":"og:description","content":"Welcome to the Upvest API documentation. Here you will find all the information you need to integrate with our API."},{"name":"og:image","content":"/assets/upvest-logo-card.ee25ccc59849324b0b73151a5c972c87639419556344db0b6dcf518151cb4c3c.925ff8b2.png"}]},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"access-the-documentation-mcp-server","__idx":0},"children":["Access the documentation MCP server"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Our documentation exposes a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://modelcontextprotocol.io"},"children":["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."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"endpoints","__idx":1},"children":["Endpoints"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["We publish two endpoints. Choose based on whether you have an account for our documentation portal."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"URL"},"children":["URL"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Authentication"},"children":["Authentication"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Content served"},"children":["Content served"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Public"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://docs.upvest.co/mcp-public"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No credentials required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Public documentation only."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authenticated"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://docs.upvest.co/mcp"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required — sign in when your client prompts you"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Everything your account is entitled to see, including custom client content."]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Opening either URL in a browser shows a setup page with copy-ready connection snippets. The two pages link to each other."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both endpoints use the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"connect-your-client","__idx":2},"children":["Connect your client"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Replace ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<URL>"]}," with the endpoint you chose from the table above."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"cursor","__idx":3},"children":["Cursor"]},{"$$mdtype":"Tag","name":"Steps","attributes":{},"children":[{"$$mdtype":"Tag","name":"Step","attributes":{"title":"Open MCP settings"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Open the command palette (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Cmd+Shift+P"]}," on macOS, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ctrl+Shift+P"]}," on Windows/Linux) and run ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Open MCP settings"]},"."]}]},{"$$mdtype":"Tag","name":"Step","attributes":{"title":"Add a custom MCP server"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Add custom MCP"]},". Cursor opens ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mcp.json"]},"."]}]},{"$$mdtype":"Tag","name":"Step","attributes":{"title":"Add the server and save"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add the server and save:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"mcpServers\": {\n    \"upvest-docs\": {\n      \"url\": \"<URL>\"\n    }\n  }\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"Step","attributes":{"title":"Sign in to finish"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Return to MCP settings. If prompted, select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Needs login"]}," and complete sign-in. Cursor then lists the available tools."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"claude-code","__idx":4},"children":["Claude Code"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"claude mcp add --transport http upvest-docs <URL>\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Type ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/mcp"]}," in the CLI and complete authentication if prompted."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"claude-desktop","__idx":5},"children":["Claude Desktop"]},{"$$mdtype":"Tag","name":"Steps","attributes":{},"children":[{"$$mdtype":"Tag","name":"Step","attributes":{"title":"Open the connector settings"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Go to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Customize → Connectors → Add custom connector"]},"."]}]},{"$$mdtype":"Tag","name":"Step","attributes":{"title":"Add the endpoint"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Paste ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<URL>"]}," and click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Add"]},"."]}]},{"$$mdtype":"Tag","name":"Step","attributes":{"title":"Sign in to finish"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Sign in if prompted."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"vs-code","__idx":6},"children":["VS Code"]},{"$$mdtype":"Tag","name":"Steps","attributes":{},"children":[{"$$mdtype":"Tag","name":"Step","attributes":{"title":"Add an MCP server"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Open the command palette and run ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["MCP: Add Server"]},"."]}]},{"$$mdtype":"Tag","name":"Step","attributes":{"title":"Configure the connection"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["HTTP"]},", enter ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<URL>"]},", and name the connection."]}]},{"$$mdtype":"Tag","name":"Step","attributes":{"title":"Sign in to finish"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If prompted, complete sign-in in the browser."]}]},{"$$mdtype":"Tag","name":"Step","attributes":{"title":"Confirm the tools appear"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In Chat (Agent mode), select the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Tools"]}," icon to confirm the server and its tools appear."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"codex-cli","__idx":7},"children":["Codex CLI"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"codex mcp add upvest-docs --url <URL>\ncodex mcp login upvest-docs   # authenticated endpoint only\ncodex mcp list\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"chatgpt-desktop-app","__idx":8},"children":["ChatGPT desktop app"]},{"$$mdtype":"Tag","name":"Steps","attributes":{},"children":[{"$$mdtype":"Tag","name":"Step","attributes":{"title":"Open the MCP settings"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Go to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Settings → Plugins → MCPs"]},"."]}]},{"$$mdtype":"Tag","name":"Step","attributes":{"title":"Add the server"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add a server of type ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Streamable HTTP"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<URL>"]},"."]}]},{"$$mdtype":"Tag","name":"Step","attributes":{"title":"Restart the app"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Restart the app."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"verify-the-connection","__idx":9},"children":["Verify the connection"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In your assistant's chat (agent mode where applicable), ask a question that requires our documentation, for example: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Which endpoint creates an order, and what fields are required?\""]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The assistant should call a tool from the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["upvest-docs"]}," server before answering."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"automated-discovery","__idx":10},"children":["Automated discovery"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Agents can discover the server without manual configuration through the MCP server card:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET https://docs.upvest.co/.well-known/mcp/server-card.json\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The card lists the transport endpoint, capabilities, authentication requirements, and available tools."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"troubleshooting","__idx":11},"children":["Troubleshooting"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Symptom"},"children":["Symptom"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Cause"},"children":["Cause"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Fix"},"children":["Fix"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}," from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/mcp"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["You are not signed in"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Complete the sign-in flow in your client, or switch to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/mcp-public"]}," (the 401 response body includes the URL)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403 Forbidden"]}," from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/mcp"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your account does not have MCP access"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contact your Upvest representative."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tools appear but answers omit content you can see in the portal"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AI agent is connected to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/mcp-public"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reconnect using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/mcp"]}," and sign in."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AI agent cannot open a browser for sign-in"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Headless or restricted environment"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/mcp-public"]},", or pass an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," header in the client configuration where supported."]}]}]}]}]}]},"headings":[{"value":"Access the documentation MCP server","id":"access-the-documentation-mcp-server","depth":1},{"value":"Endpoints","id":"endpoints","depth":2},{"value":"Connect your client","id":"connect-your-client","depth":2},{"value":"Cursor","id":"cursor","depth":3},{"value":"Claude Code","id":"claude-code","depth":3},{"value":"Claude Desktop","id":"claude-desktop","depth":3},{"value":"VS Code","id":"vs-code","depth":3},{"value":"Codex CLI","id":"codex-cli","depth":3},{"value":"ChatGPT desktop app","id":"chatgpt-desktop-app","depth":3},{"value":"Verify the connection","id":"verify-the-connection","depth":2},{"value":"Automated discovery","id":"automated-discovery","depth":2},{"value":"Troubleshooting","id":"troubleshooting","depth":2}],"frontmatter":{"seo":{"title":"Access the documentation MCP server"}},"lastModified":"2026-09-21T08:49:44.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/mcp-server","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}