{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition","cards","card"]},"type":"markdown"},"seo":{"title":"AI assistant and MCP server"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"ai-assistant-and-mcp-server","__idx":0},"children":["AI assistant and MCP server"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This page is for developers who want AI help while they build a VBAPI integration. It explains the portal's two AI features, what each one can and cannot see, and how to use them without exposing credentials or member data."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"the-two-features","__idx":1},"children":["The two features"]},{"$$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":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"AI assistant"},"children":["AI assistant"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"MCP server"},"children":["MCP server"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Where you use it"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["In this portal: select the chat button on any page"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["In your own AI tool, such as Cursor, VS Code, or Claude, connected to the portal's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/mcp"]}," endpoint"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["What it answers from"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The pages published on this portal and the API reference"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The same pages and the same OpenAPI description"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Setup"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/ai/connect-your-tools"},"children":["Connect your AI tools"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both features know only what is published here. If a published page is wrong, the AI repeats the mistake, so check every operation it names in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api"},"children":["API reference"]}," before you rely on it."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The MCP server is at ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://vbapi-docs.vbasoftware.com/mcp"]},". It gives your own AI tool the same knowledge the portal's assistant has, so the tool can look up endpoints, parameters, and schemas while it writes code in your editor."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-they-can-and-cannot-see","__idx":2},"children":["What they can and cannot see"]},{"$$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":"They can see"},"children":["They can see"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"They cannot see"},"children":["They cannot see"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Published pages: Get started, Concepts, Playbooks, AI and MCP, and Help and reference"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your API key, password, tokens, client ID, or client code"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The OpenAPI description: paths, parameters, request and response schemas, and security schemes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your database or any record in it: groups, members, claims, or payments"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Any response from the VBASoftware API"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unpublished or internal content"]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"The MCP server is documentation-only"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The MCP server never calls the VBASoftware API, never sees client data, and never needs VBASoftware credentials. 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."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The AI assistant also sees what you type into the chat. When you connect an MCP client, your own AI tool decides what it sends to its model, so its privacy terms apply to your code and prompts. The MCP server only receives the tool requests the client makes, such as a search phrase or an endpoint path."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"use-them-safely","__idx":3},"children":["Use them safely"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Never paste secrets or real data."]}," Do not put passwords, API keys, tokens, or real member, provider, or claim data (PHI) into a prompt. Use obviously fake values such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DOCS-SUB0001"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sample Member"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Treat every answer as a draft."]}," Check each ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["METHOD /path"]}," against the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api"},"children":["API reference"]},", and check required fields against the schema there."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Remember that your code calls production."]}," Clients only have access to the production API, so code you run writes real records in the database you name in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vbasoftware-database"]},". Try write calls in a non-production database first if VBA has given you one."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Ask for the playbook."]}," For multi-step work, name the playbook in your question, for example \"Using the Enroll employees and dependents playbook\". ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/ai/build-with-ai"},"children":["Build with AI"]}," has a ready-made prompt for each playbook."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":4},"children":["Next steps"]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":3,"cardMinWidth":240},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Connect your AI tools","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/developer-portal/ai/connect-your-tools"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Set up Cursor, VS Code, Visual Studio, Claude, or another MCP client."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Build with AI","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/developer-portal/ai/build-with-ai"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Prompt recipes for each playbook, and a checklist before you ship."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Quick start","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/developer-portal/get-started/quick-start"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Make your first authenticated call without AI help."]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For questions the documentation does not answer, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/help/support"},"children":["Support and escalation"]},"."]}]},"headings":[{"value":"AI assistant and MCP server","id":"ai-assistant-and-mcp-server","depth":1},{"value":"The two features","id":"the-two-features","depth":2},{"value":"What they can and cannot see","id":"what-they-can-and-cannot-see","depth":2},{"value":"Use them safely","id":"use-them-safely","depth":2},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"title":"AI assistant and MCP server","description":"What the portal's AI assistant and MCP server can and cannot see, and how to use them safely.","seo":{"title":"AI assistant and MCP server"}},"lastModified":"2026-10-26T21:09:33.691Z","pagePropGetterError":{"message":"","name":""}},"slug":"/developer-portal/ai/overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}