{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition","connect-mcp","tabs","tab"]},"type":"markdown"},"seo":{"title":"Connect your AI tools"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"connect-your-ai-tools","__idx":0},"children":["Connect your AI tools"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This page is for developers who want their own AI coding tool to look up VBAPI endpoints, parameters, and schemas while it writes code. It shows how to connect common MCP clients to the VBASoftware MCP server and how to check that the connection works."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"What the MCP server will never do"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Call the VBASoftware API, or read or change any record in your database."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ask for, store, or forward your VBASoftware API key, password, or tokens."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["See client data such as members, claims, or payments."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["It only searches and returns the published documentation and the API description. If an MCP tool or your AI client asks you for VBASoftware credentials, do not enter them, and tell VBA support. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/ai/overview"},"children":["AI assistant and MCP server"]}," for what the AI features can and cannot see."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"server-details","__idx":1},"children":["Server details"]},{"$$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":"Setting"},"children":["Setting"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Server URL"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://vbapi-docs.vbasoftware.com/mcp"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transport"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Streamable HTTP (called ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["http"]}," in most client configurations)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sign-in"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None. Do not add headers or an API key."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Server name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VBASoftware MCP Server"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"use-the-connect-to-mcp-button","__idx":2},"children":["Use the Connect to MCP button"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The quickest way to connect is the button below. It offers a one-click install for Cursor and VS Code, a Claude connector link, the Claude Code and Codex commands, and a copy of the server URL."]},{"$$mdtype":"Tag","name":"ConnectMCP","attributes":{"placement":"bottom","alignment":"start","options":["cursor","vscode","claude","claude-code","codex","copy"]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the button does not suit your setup, use the steps for your client below."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"set-up-your-client","__idx":3},"children":["Set up your client"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Client settings change often. Each tab links to the client's own documentation; follow it if a menu name has moved."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Cursor","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add the server to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["~/.cursor/mcp.json"]}," to use it in every project, or to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".cursor/mcp.json"]}," in one project:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"mcpServers\": {\n    \"vbasoftware-mcp-server\": {\n      \"url\": \"https://vbapi-docs.vbasoftware.com/mcp\"\n    }\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the file already has an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mcpServers"]}," object, add the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vbasoftware-mcp-server"]}," entry to it. Then check that the server is turned on in Cursor's MCP settings and that its tools are listed."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Cursor documentation: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://cursor.com/docs/context/mcp"},"children":["Model Context Protocol (MCP)"]},"."]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"VS Code (GitHub Copilot)","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Open the Command Palette, run ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["MCP: Add Server"]},", choose ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["HTTP"]},", enter ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://vbapi-docs.vbasoftware.com/mcp"]},", and use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vbasoftware-mcp-server"]}," as the server ID."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To share the server with your team through the repository instead, add it to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".vscode/mcp.json"]}," in the workspace:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"servers\": {\n    \"vbasoftware-mcp-server\": {\n      \"type\": \"http\",\n      \"url\": \"https://vbapi-docs.vbasoftware.com/mcp\"\n    }\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The portable Copilot files (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".mcp.json"]}," at the workspace root, or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["~/.copilot/mcp-config.json"]},") use a top-level ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mcpServers"]}," object instead of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["servers"]},", with the same entry inside. Use the server in an agent session."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["VS Code documentation: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://code.visualstudio.com/docs/copilot/customization/mcp-servers"},"children":["Add MCP servers in VS Code"]}," and the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://code.visualstudio.com/docs/copilot/reference/mcp-configuration"},"children":["MCP configuration reference"]},"."]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Visual Studio","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Visual Studio 2022 version 17.14 or later, or Visual Studio 2026, reads ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".mcp.json"]}," from the solution folder, or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["%USERPROFILE%\\.mcp.json"]}," for every solution:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"servers\": {\n    \"vbasoftware-mcp-server\": {\n      \"type\": \"http\",\n      \"url\": \"https://vbapi-docs.vbasoftware.com/mcp\"\n    }\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Save the file, switch the Copilot chat pane to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Agent"]}," mode, open ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Tools"]},", and turn on the VBASoftware tools. Visual Studio adds new MCP tools turned off."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Visual Studio documentation: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers"},"children":["Use MCP servers"]},"."]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Claude Desktop","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Claude Desktop connects to remote servers as custom connectors, not through ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["claude_desktop_config.json"]},", which is only for servers that run on your computer."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Customize"]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Connectors"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Add"]},", then ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Custom"]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Web"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Name the connector ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VBASoftware MCP Server"]}," and enter ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://vbapi-docs.vbasoftware.com/mcp"]}," as the URL."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Under ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authentication"]},", choose ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["No sign in"]},", then select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Add"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["On Team and Enterprise plans, an organization Owner adds the connector first under ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Organization settings"]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Connectors"]},", and then each member connects to it. Claude reaches the server from Anthropic's cloud, which works because the portal is public."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Claude documentation: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://support.claude.com/en/articles/11175166-get-started-with-custom-connectors-using-remote-mcp"},"children":["Custom connectors using remote MCP"]},"."]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Claude Code","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Run:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","header":{"controls":{"copy":{}}},"source":"claude mcp add --transport http vbasoftware-mcp-server https://vbapi-docs.vbasoftware.com/mcp\n","lang":"shell"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The server is added for the current project only. Add ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--scope user"]}," to use it in every project, or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--scope project"]}," to write it to the project's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".mcp.json"]}," so your team gets it too. Check the connection with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["claude mcp get vbasoftware-mcp-server"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Claude Code documentation: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://docs.anthropic.com/en/docs/claude-code/mcp"},"children":["Connect Claude Code to tools via MCP"]},"."]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Other MCP clients","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Any client that supports remote MCP servers over Streamable HTTP can connect. Give it the server URL ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://vbapi-docs.vbasoftware.com/mcp"]},", and choose no authentication."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["ChatGPT:"]}," on ChatGPT on the web, add the server as a custom MCP server with no authentication. Whether you can add one depends on your ChatGPT plan and your workspace's settings. See OpenAI's ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developers.openai.com/api/docs/guides/custom-mcp-server"},"children":["Add custom MCP server"]}," guide."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Codex:"]}," the Connect to MCP button above gives the command."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Clients that only start local MCP servers from a command cannot connect directly."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"check-the-connection","__idx":4},"children":["Check the connection"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ask your AI tool:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"text","header":{"controls":{"copy":{}}},"source":"Using the VBASoftware MCP server, which endpoint adds a claim to a claim batch? Give the method and path.\n","lang":"text"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A working connection shows a call to one of the server's tools in the conversation, and the answer names ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/claim-batch/createclaimbatch"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /claim-batches/{batchNumber}/claims"]}]},". If the answer appears without a tool call from the VBASoftware server, the client answered from its own training data: check that the server is turned on and ask again, naming the server."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"tools-the-server-provides","__idx":5},"children":["Tools the server provides"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All of these tools only read the published documentation and the API description."]},{"$$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":"Tool"},"children":["Tool"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What it does"},"children":["What it does"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["list-apis"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Lists the APIs documented on the portal."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get-endpoints"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Lists every endpoint of an API, with its method, path, and summary."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get-endpoint-info"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns one endpoint in full: parameters, request body, responses, and security."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get-security-schemes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns the API's security schemes, such as the API key and bearer token."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get-full-api-description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns the whole OpenAPI description. It is large, so prefer ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get-endpoint-info"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["search"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Searches the published pages for a word or phrase."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Some clients see two tools instead, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["describe-tools"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["execute"]},". They run the same documentation lookups as one script in Redocly's sandbox, which saves round trips. They do not change what the server can see."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"troubleshooting","__idx":6},"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":"What you see"},"children":["What you see"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What to do"},"children":["What to do"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The server is listed, but its tools never run"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Turn the tools on in the client's tool list. Visual Studio adds new MCP tools turned off."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The answer has no tool call from the VBASoftware server"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name the server in the prompt, for example \"Using the VBASoftware MCP server\"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Visual Studio asks you to trust the server again"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Visual Studio asks again when a server's tools change. Check that the URL is still ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://vbapi-docs.vbasoftware.com/mcp"]}," before you accept."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Next, try the prompt recipes in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/ai/build-with-ai"},"children":["Build with AI"]},"."]}]},"headings":[{"value":"Connect your AI tools","id":"connect-your-ai-tools","depth":1},{"value":"Server details","id":"server-details","depth":2},{"value":"Use the Connect to MCP button","id":"use-the-connect-to-mcp-button","depth":2},{"value":"Set up your client","id":"set-up-your-client","depth":2},{"value":"Check the connection","id":"check-the-connection","depth":2},{"value":"Tools the server provides","id":"tools-the-server-provides","depth":2},{"value":"Troubleshooting","id":"troubleshooting","depth":2}],"frontmatter":{"title":"Connect your AI tools","description":"Connect Cursor, VS Code, Visual Studio, Claude, or another MCP client to the VBASoftware MCP server and check that it works.","seo":{"title":"Connect your AI tools"}},"lastModified":"2026-10-26T21:09:33.691Z","pagePropGetterError":{"message":"","name":""}},"slug":"/developer-portal/ai/connect-your-tools","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}