Define the role, list specific responsibilities, describe how to handle common scenarios, and set boundaries on what the Agent should not do. The more context you provide, the more consistently the Agent will behave.
Example instruction:You are a portfolio research assistant for Apex Capital. Your responsibilities:
Answer analyst questions about portfolio holdings using the Query Knowledge Base tool
Find latest market news using the Research Web tool
Always cite your sources and flag when information may be outdated
Do not provide investment advice or make buy/sell recommendations
If you cannot find an answer in the Knowledge Base, say so clearly rather than guessing
Start with fewer tools and add more as needed. An Agent with 3 to 5 well-described tools will typically outperform one with 15 poorly described tools. Each tool you add is another decision the Agent has to make, so keep the toolset focused on what the Agent actually needs.
For a customer support Agent, start with just Query Knowledge Base (for FAQs), Research Web (for product updates), and Code Interpreter (for data lookups). Add more tools only after testing shows the Agent needs them.
Use “Require User Approval” for any tool that modifies external data, such as updating CRM records, sending Slack messages, or writing to files. This gives the user a chance to review and confirm before the action is taken, preventing accidental changes.
Set tools like Airtable > Update Records, Slack > Send Message, and Google Sheets > Write Cell to Require User Approval. Keep read-only tools like Research Web and Query Knowledge Base on Auto Run for a smooth experience.
When building multi-agent setups, keep each sub-agent focused on a single domain. A “Fixed Income Agent” that only handles bond and rate questions will be more reliable than a general “Research Agent” that handles everything.
In your main Agent’s instructions, define clear routing logic:When the user asks about fixed income or bonds, use the Run Agent tool to call the Fixed Income Agent. When the user asks about equities or stock positions, use the Run Agent tool to call the Equities Agent.
Upload your most important documents to the Knowledge Base first and test retrieval in the chat preview before adding more. This lets you verify that the chunk size, overlap, and embedding model are working well for your content before scaling up.
Upload 3–5 representative documents first. Ask the Agent questions you know the answers to and check whether the responses are accurate and well-sourced. If retrieval is off, adjust the settings before adding the full document set.
Use @ tagging to debug and reference specific resources
Use the @ tag feature in chat to explicitly reference specific tools, knowledge bases, agents, or other resources. This is useful both for debugging and for directing the Agent to use a specific resource.
Examples of @ tag usage:
Type @Q4 Earnings Report to force the Agent to query that specific Knowledge Base document: “@Q4 Earnings Report What was our revenue growth last quarter?”
Type @Fixed Income Agent to route a question to a specific sub-agent: “@Fixed Income Agent What is the current yield curve for Treasury bonds?”
Type @Code Interpreter to force the Agent to use code for a calculation: “@Code Interpreter Calculate the compound annual growth rate from $100K to $250K over 5 years”
This is especially useful when the Agent picks the wrong tool or Knowledge Base automatically — tagging lets you override its decision and test specific resources in isolation.
Monitor the Manager tab regularly after deploying your Agent. The sessions table lets you review actual conversations, which is the best way to spot issues with instructions, tool usage, or knowledge base gaps that you might not catch during testing.
Look for patterns in conversations where the Agent fails: Does it pick the wrong tool? Does it miss information from the Knowledge Base? Use these patterns to refine your instructions and tool descriptions.
Enable “Show Sources” in the AI Model’s Advanced Settings when your Agent answers questions from a Knowledge Base. This builds user trust by letting them see where the information came from — especially important for compliance, risk, and regulatory use cases where analysts need to verify citations.
With Show Sources enabled, the Agent will display clickable source references alongside its answers, so users can verify the original documents. This is critical for regulated industries where audit trails matter.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"VectorShift","colors":{"primary":"#6366f1","light":"#818cf8","dark":"#4f46e5"},"logo":{"light":"https://mintcdn.com/vectorshift/ko1lD3nuBSgpmLV4/logo/vectorshift-logo.png?fit=max\u0026auto=format\u0026n=ko1lD3nuBSgpmLV4\u0026q=85\u0026s=0b909e21221badbcd2332ad0c7b06a8e","dark":"https://mintcdn.com/vectorshift/ko1lD3nuBSgpmLV4/logo/vectorshift-logo.png?fit=max\u0026auto=format\u0026n=ko1lD3nuBSgpmLV4\u0026q=85\u0026s=0b909e21221badbcd2332ad0c7b06a8e"},"favicon":"https://mintcdn.com/vectorshift/PSG1OGMwi51Mi0EL/android-chrome-512x512.png?fit=max\u0026auto=format\u0026n=PSG1OGMwi51Mi0EL\u0026q=85\u0026s=1a5016324923f89a576a8696462ef07e","appearance":{"default":"system","strict":false},"navbar":{"links":[{"href":"/support","label":"Support"},{"href":"https://app.vectorshift.ai/account/api-keys","label":"API Keys"}],"primary":{"type":"button","label":"Platform","href":"https://app.vectorshift.ai"}},"footer":{"socials":{"x":"https://x.com/vectorshiftai","linkedin":"https://linkedin.com/company/vectorshift"}},"search":{"prompt":"Search the SDK, API, and platform docs…"},"seo":{"metatags":{"og:image":"/logo/vectorshift-logo.png"},"indexing":"navigable"},"icons":{"library":"lucide"},"styling":{"codeblocks":{"languages":{}},"latex":true},"contextual":{"options":["copy","view","chatgpt","claude","aistudio","perplexity"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Book a Demo","icon":"calendar","href":"https://calendly.com/albert_mao/vectorshift-intro-chat"},{"anchor":"Changelog","icon":"history","href":"https://vectorshift.ai/blog?tag=changelog"},{"anchor":"Blog","icon":"newspaper","href":"https://vectorshift.ai/blog"},{"anchor":"Tutorials","icon":"youtube","href":"https://www.youtube.com/@VectorShiftAI"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vectorshift","hasAudioNarration":false,"actualSubdomain":"vectorshift","customDomains":["docs.vectorshift.ai"],"gitSource":{"type":"github","owner":"vectorshift","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a4fe02b59f45c534f1a9960","collectionId":"f85b947e-62c3-492f-9432-347ee09473da","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a58eb7c7bfe054002014416:success","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"SDK","count":136},{"language":"default","tag":"Documentation","count":124},{"language":"default","tag":"Examples","count":84},{"language":"default","tag":"Nodes","count":65},{"language":"default","tag":"Platform","count":61},{"language":"default","tag":"Pipeline","count":38},{"language":"default","tag":"API Reference","count":30},{"language":"default","tag":"Agent","count":27},{"language":"default","tag":"Knowledge Base","count":24},{"language":"default","tag":"Interfaces","count":20}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@media (min-width:1024px){.hidden.xl\\:flex{display:flex!important}div.z-10.hidden:has(>div.xl\\:flex){display:block!important}}"}],"page":{"pagePath":"platform/agents/tips","slug":"/platform/agents/tips","pageMetadata":{"title":"Tips and Best Practices","description":"Guidelines for building effective, reliable Agents","href":"/platform/agents/tips"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Guidelines for building effective, reliable Agents\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,em:`em`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Heading,OptimizedImage,Tip}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`write-instructions-like-a-job-description`,children:`Write instructions like a job description`}),`\n`,_jsx(_components.p,{children:`Define the role, list specific responsibilities, describe how to handle common scenarios, and set boundaries on what the Agent should not do. The more context you provide, the more consistently the Agent will behave.`}),`\n`,_jsxs(Tip,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Example instruction:`})}),_jsx(_components.p,{children:_jsx(_components.em,{children:`You are a portfolio research assistant for Apex Capital. Your responsibilities:`})}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.em,{children:`Answer analyst questions about portfolio holdings using the Query Knowledge Base tool`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.em,{children:`Find latest market news using the Research Web tool`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.em,{children:`Always cite your sources and flag when information may be outdated`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.em,{children:`Do not provide investment advice or make buy/sell recommendations`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.em,{children:`If you cannot find an answer in the Knowledge Base, say so clearly rather than guessing`})}),`\n`]})]}),`\n`,_jsx(Heading,{level:`2`,id:`start-lean-on-tools`,children:`Start lean on tools`}),`\n`,_jsx(_components.p,{children:`Start with fewer tools and add more as needed. An Agent with 3 to 5 well-described tools will typically outperform one with 15 poorly described tools. Each tool you add is another decision the Agent has to make, so keep the toolset focused on what the Agent actually needs.`}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`For a customer support Agent, start with just `,_jsx(_components.strong,{children:`Query Knowledge Base`}),` (for FAQs), `,_jsx(_components.strong,{children:`Research Web`}),` (for product updates), and `,_jsx(_components.strong,{children:`Code Interpreter`}),` (for data lookups). Add more tools only after testing shows the Agent needs them.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`gate-tools-that-modify-data`,children:`Gate tools that modify data`}),`\n`,_jsx(_components.p,{children:`Use “Require User Approval” for any tool that modifies external data, such as updating CRM records, sending Slack messages, or writing to files. This gives the user a chance to review and confirm before the action is taken, preventing accidental changes.`}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`Set tools like `,_jsx(_components.strong,{children:`Airtable > Update Records`}),`, `,_jsx(_components.strong,{children:`Slack > Send Message`}),`, and `,_jsx(_components.strong,{children:`Google Sheets > Write Cell`}),` to Require User Approval. Keep read-only tools like `,_jsx(_components.strong,{children:`Research Web`}),` and `,_jsx(_components.strong,{children:`Query Knowledge Base`}),` on Auto Run for a smooth experience.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`keep-sub-agents-domain-focused`,children:`Keep sub-agents domain-focused`}),`\n`,_jsx(_components.p,{children:`When building multi-agent setups, keep each sub-agent focused on a single domain. A “Fixed Income Agent” that only handles bond and rate questions will be more reliable than a general “Research Agent” that handles everything.`}),`\n`,_jsxs(Tip,{children:[_jsx(_components.p,{children:`In your main Agent’s instructions, define clear routing logic:`}),_jsx(_components.p,{children:_jsx(_components.em,{children:`When the user asks about fixed income or bonds, use the Run Agent tool to call the Fixed Income Agent. When the user asks about equities or stock positions, use the Run Agent tool to call the Equities Agent.`})})]}),`\n`,_jsx(Heading,{level:`2`,id:`test-retrieval-before-scaling-your-knowledge-base`,children:`Test retrieval before scaling your knowledge base`}),`\n`,_jsx(_components.p,{children:`Upload your most important documents to the Knowledge Base first and test retrieval in the chat preview before adding more. This lets you verify that the chunk size, overlap, and embedding model are working well for your content before scaling up.`}),`\n`,_jsx(Tip,{children:_jsx(_components.p,{children:`Upload 3–5 representative documents first. Ask the Agent questions you know the answers to and check whether the responses are accurate and well-sourced. If retrieval is off, adjust the settings before adding the full document set.`})}),`\n`,_jsx(Heading,{level:`2`,id:`use-@-tagging-to-debug-and-reference-specific-resources`,children:`Use @ tagging to debug and reference specific resources`}),`\n`,_jsxs(_components.p,{children:[`Use the `,_jsx(_components.strong,{children:`@`}),` tag feature in chat to explicitly reference specific tools, knowledge bases, agents, or other resources. This is useful both for debugging and for directing the Agent to use a specific resource.`]}),`\n`,_jsx(OptimizedImage,{src:`https://mintcdn.com/vectorshift/1xkNpYr5adROGL-v/images/platform/agents/at-tag-menu.png?fit=max\u0026auto=format\u0026n=1xkNpYr5adROGL-v\u0026q=85\u0026s=70211c50ab0ae63e36233860a719c6ea`,alt:`@ tag dropdown menu showing available resources`,\"data-og-width\":`1100`,width:`1100`,\"data-og-height\":`480`,height:`480`,\"data-path\":`images/platform/agents/at-tag-menu.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/vectorshift/1xkNpYr5adROGL-v/images/platform/agents/at-tag-menu.png?w=280\u0026fit=max\u0026auto=format\u0026n=1xkNpYr5adROGL-v\u0026q=85\u0026s=bfdc91d980cadb4c761b290cc3501ef2 280w, https://mintcdn.com/vectorshift/1xkNpYr5adROGL-v/images/platform/agents/at-tag-menu.png?w=560\u0026fit=max\u0026auto=format\u0026n=1xkNpYr5adROGL-v\u0026q=85\u0026s=44ce0f09997e23bf6a256d805ca782b2 560w, https://mintcdn.com/vectorshift/1xkNpYr5adROGL-v/images/platform/agents/at-tag-menu.png?w=840\u0026fit=max\u0026auto=format\u0026n=1xkNpYr5adROGL-v\u0026q=85\u0026s=92fffcad05815cef9c5593fe58c4159f 840w, https://mintcdn.com/vectorshift/1xkNpYr5adROGL-v/images/platform/agents/at-tag-menu.png?w=1100\u0026fit=max\u0026auto=format\u0026n=1xkNpYr5adROGL-v\u0026q=85\u0026s=15a136440f510d08cbd6c119c85a93cc 1100w, https://mintcdn.com/vectorshift/1xkNpYr5adROGL-v/images/platform/agents/at-tag-menu.png?w=1650\u0026fit=max\u0026auto=format\u0026n=1xkNpYr5adROGL-v\u0026q=85\u0026s=266281c2f7b5d34740e1339e97a23ae2 1650w, https://mintcdn.com/vectorshift/1xkNpYr5adROGL-v/images/platform/agents/at-tag-menu.png?w=2500\u0026fit=max\u0026auto=format\u0026n=1xkNpYr5adROGL-v\u0026q=85\u0026s=e3bca1c794f94897bf4a2b995b628af8 2500w`}),`\n`,_jsxs(Tip,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Examples of @ tag usage:`})}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Type `,_jsx(_components.code,{children:`@Q4 Earnings Report`}),` to force the Agent to query that specific Knowledge Base document: `,_jsxs(_components.em,{children:[`“`,_jsx(_components.code,{children:`@Q4 Earnings Report`}),` What was our revenue growth last quarter?”`]})]}),`\n`,_jsxs(_components.li,{children:[`Type `,_jsx(_components.code,{children:`@Fixed Income Agent`}),` to route a question to a specific sub-agent: `,_jsxs(_components.em,{children:[`“`,_jsx(_components.code,{children:`@Fixed Income Agent`}),` What is the current yield curve for Treasury bonds?”`]})]}),`\n`,_jsxs(_components.li,{children:[`Type `,_jsx(_components.code,{children:`@Code Interpreter`}),` to force the Agent to use code for a calculation: `,_jsxs(_components.em,{children:[`“`,_jsx(_components.code,{children:`@Code Interpreter`}),` Calculate the compound annual growth rate from `,`$100K to $`,`250K over 5 years”`]})]}),`\n`]}),_jsx(_components.p,{children:`This is especially useful when the Agent picks the wrong tool or Knowledge Base automatically — tagging lets you override its decision and test specific resources in isolation.`})]}),`\n`,_jsx(Heading,{level:`2`,id:`review-real-conversations-in-the-manager-tab`,children:`Review real conversations in the Manager tab`}),`\n`,_jsx(_components.p,{children:`Monitor the Manager tab regularly after deploying your Agent. The sessions table lets you review actual conversations, which is the best way to spot issues with instructions, tool usage, or knowledge base gaps that you might not catch during testing.`}),`\n`,_jsx(Tip,{children:_jsx(_components.p,{children:`Look for patterns in conversations where the Agent fails: Does it pick the wrong tool? Does it miss information from the Knowledge Base? Use these patterns to refine your instructions and tool descriptions.`})}),`\n`,_jsx(Heading,{level:`2`,id:`surface-sources-for-knowledge-base-answers`,children:`Surface sources for knowledge base answers`}),`\n`,_jsx(_components.p,{children:`Enable “Show Sources” in the AI Model’s Advanced Settings when your Agent answers questions from a Knowledge Base. This builds user trust by letting them see where the information came from — especially important for compliance, risk, and regulatory use cases where analysts need to verify citations.`}),`\n`,_jsx(Tip,{children:_jsx(_components.p,{children:`With Show Sources enabled, the Agent will display clickable source references alongside its answers, so users can verify the original documents. This is critical for regulated industries where audit trails matter.`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"languages":{}},"config":{},"pageMetadata":{"title":"Tips and Best Practices","description":"Guidelines for building effective, reliable Agents","href":"/platform/agents/tips"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Write instructions like a job description","slug":"write-instructions-like-a-job-description","depth":2,"children":[]},{"title":"Start lean on tools","slug":"start-lean-on-tools","depth":2,"children":[]},{"title":"Gate tools that modify data","slug":"gate-tools-that-modify-data","depth":2,"children":[]},{"title":"Keep sub-agents domain-focused","slug":"keep-sub-agents-domain-focused","depth":2,"children":[]},{"title":"Test retrieval before scaling your knowledge base","slug":"test-retrieval-before-scaling-your-knowledge-base","depth":2,"children":[]},{"title":"Use @ tagging to debug and reference specific resources","slug":"use-@-tagging-to-debug-and-reference-specific-resources","depth":2,"children":[]},{"title":"Review real conversations in the Manager tab","slug":"review-real-conversations-in-the-manager-tab","depth":2,"children":[]},{"title":"Surface sources for knowledge base answers","slug":"surface-sources-for-knowledge-base-answers","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"vectorshift","siteName":"VectorShift","title":"Tips and Best Practices - VectorShift","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-07T12:17:18.622Z","originalFileLocation":"platform/agents/tips.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Guidelines for building effective, reliable Agents\">\u003cmeta data-mint-head name=\"application-name\" content=\"VectorShift\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vectorshift/TwRU3RaBNwnTjf5H/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/vectorshift/TwRU3RaBNwnTjf5H/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vectorshift/TwRU3RaBNwnTjf5H/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/vectorshift/TwRU3RaBNwnTjf5H/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/vectorshift/TwRU3RaBNwnTjf5H/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vectorshift/TwRU3RaBNwnTjf5H/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vectorshift/TwRU3RaBNwnTjf5H/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/vectorshift/TwRU3RaBNwnTjf5H/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/vectorshift/TwRU3RaBNwnTjf5H/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Tips and Best Practices - VectorShift\">\u003cmeta data-mint-head property=\"og:description\" content=\"Guidelines for building effective, reliable Agents\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"VectorShift\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.vectorshift.ai/platform/agents/tips\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vectorshift.mintlify.app/logo/vectorshift-logo.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Tips and Best Practices - VectorShift\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Guidelines for building effective, reliable Agents\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vectorshift.mintlify.app/logo/vectorshift-logo.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/vectorshift/TwRU3RaBNwnTjf5H/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"VectorShift\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6366f1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.vectorshift.ai/platform/agents/tips\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/platform/agents/tips.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.vectorshift.ai/#organization\",\"name\":\"VectorShift\",\"url\":\"https://docs.vectorshift.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/vectorshift/ko1lD3nuBSgpmLV4/logo/vectorshift-logo.png?fit=max\u0026auto=format\u0026n=ko1lD3nuBSgpmLV4\u0026q=85\u0026s=0b909e21221badbcd2332ad0c7b06a8e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.vectorshift.ai#website\",\"name\":\"VectorShift\",\"url\":\"https://docs.vectorshift.ai\",\"publisher\":{\"@id\":\"https://docs.vectorshift.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.vectorshift.ai/platform/agents/tips#webpage\",\"url\":\"https://docs.vectorshift.ai/platform/agents/tips\",\"name\":\"Tips and Best Practices\",\"description\":\"Guidelines for building effective, reliable Agents\",\"dateModified\":\"2026-04-07T12:17:18.622Z\",\"isPartOf\":{\"@id\":\"https://docs.vectorshift.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.vectorshift.ai/platform/agents/tips#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.vectorshift.ai/platform/agents/tips#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Platform\",\"item\":\"https://docs.vectorshift.ai/platform/pipelines/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Agents\",\"item\":\"https://docs.vectorshift.ai/platform/agents/introduction\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Tips and Best Practices\",\"item\":\"https://docs.vectorshift.ai/platform/agents/tips\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.vectorshift.ai/platform/agents/tips#article\",\"headline\":\"Tips and Best Practices\",\"name\":\"Tips and Best Practices\",\"description\":\"Guidelines for building effective, reliable Agents\",\"url\":\"https://docs.vectorshift.ai/platform/agents/tips\",\"mainEntityOfPage\":{\"@id\":\"https://docs.vectorshift.ai/platform/agents/tips#webpage\"},\"image\":\"https://docs.vectorshift.ai/logo/vectorshift-logo.png\",\"dateModified\":\"2026-04-07T12:17:18.622Z\",\"publisher\":{\"@id\":\"https://docs.vectorshift.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.vectorshift.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"VectorShift\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"VectorShift","nav":{"global":{"anchors":[{"anchor":"Book a Demo","icon":"calendar","href":"https://calendly.com/albert_mao/vectorshift-intro-chat"},{"anchor":"Changelog","icon":"history","href":"https://vectorshift.ai/blog?tag=changelog"},{"anchor":"Blog","icon":"newspaper","href":"https://vectorshift.ai/blog"},{"anchor":"Tutorials","icon":"youtube","href":"https://www.youtube.com/@VectorShiftAI"}]},"tabs":[{"tab":"Documentation","groups":[{"group":"Get Started","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Quickstart","href":"/quickstart"},{"title":"Support","href":"/support"},{"title":"Sub-processors","href":"/sub-processors"}]},{"group":"Platform","pages":[{"group":"Workflows","pages":[{"title":"Overview","href":"/platform/pipelines/overview"},{"group":"Workflow Mechanics","pages":[{"title":"Variables","href":"/platform/pipelines/variables"},{"title":"Data Types","href":"/platform/pipelines/data-types"},{"title":"Dependencies","href":"/platform/pipelines/dependencies"}]}]},{"group":"Agents","pages":[{"title":"Agents","href":"/platform/agents/introduction"},{"title":"Build an Agent","href":"/platform/agents/build-an-agent"},{"group":"Agent Tab","pages":[{"title":"Agent Instructions","href":"/platform/agents/agent-instructions"},{"title":"AI Model","href":"/platform/agents/ai-model"},{"title":"Agent Tools","href":"/platform/agents/agent-tools"},{"title":"Knowledge Base","href":"/platform/agents/knowledge-base"},{"title":"Session Memory","href":"/platform/agents/session-memory"},{"title":"@ Tag References","href":"/platform/agents/at-tag-references"}]},{"title":"Customize Your Agent","href":"/platform/agents/interface-tab"},{"title":"Monitor Your Agent","href":"/platform/agents/manager-tab"},{"title":"Test and Deploy","href":"/platform/agents/chat-preview"},{"title":"Save and Version","href":"/platform/agents/saving-and-versioning"},{"title":"Share with Teammates","description":"Invite teammates to view or edit your Agent project","href":"/platform/agents/sharing"},{"title":"Tips and Best Practices","href":"/platform/agents/tips"}]},{"group":"Knowledge Base","pages":[{"title":"Overview","description":"Turn your documents, files, and live data into an AI-powered search experience","href":"/platform/knowledge/overview"},{"title":"Creating a New Knowledge Base","href":"/platform/knowledge/creating"},{"title":"Adding Data to Your Knowledge Base","href":"/platform/knowledge/adding-data"},{"title":"Managing Documents","href":"/platform/knowledge/managing-documents"},{"title":"Knowledge Base Settings","href":"/platform/knowledge/settings"},{"title":"Configuring Metadata on an Existing Knowledge Base","href":"/platform/knowledge/configure-metadata"},{"title":"Setting Up the Search Interface","href":"/platform/knowledge/search-interface"},{"title":"Using the Search Experience","href":"/platform/knowledge/search-experience"},{"title":"Monitoring Usage with the Manager Tab","href":"/platform/knowledge/manager-tab"},{"title":"Sharing a Knowledge Base","href":"/platform/knowledge/sharing"},{"title":"Accessing the API","href":"/platform/knowledge/api"},{"title":"Reference","href":"/platform/knowledge/reference"}]},{"group":"Interfaces","pages":[{"title":"Overview","href":"/platform/interfaces/overview"},{"group":"Chatbots","pages":[{"title":"Overview","href":"/platform/interfaces/chatbots/overview"},{"title":"Agentic Chatbot","href":"/platform/interfaces/chatbots/agentic"},{"title":"Workflow chatbot","href":"/platform/interfaces/chatbots/workflow"},{"title":"Chat Assistant vs Website Chatbot","href":"/platform/interfaces/chatbots/assistant-vs-website"},{"title":"Chat Assistant","href":"/platform/interfaces/chatbots/assistant"},{"title":"Website Chatbot","href":"/platform/interfaces/chatbots/website"},{"title":"Deploy to Slack","href":"/platform/interfaces/chatbots/slack"},{"title":"Deploy via WhatsApp and SMS","href":"/platform/interfaces/chatbots/whatsapp"},{"title":"Chat via API","href":"/platform/interfaces/chatbots/api"},{"title":"Chat analytics","href":"/platform/interfaces/chatbots/analytics"}]},{"title":"Search","href":"/platform/interfaces/search"},{"group":"Forms","pages":[{"title":"Overview","href":"/platform/interfaces/forms/overview"},{"title":"Building Your First Form","href":"/platform/interfaces/forms/building"},{"title":"Personalizing Your Form","href":"/platform/interfaces/forms/personalizing"},{"title":"Sharing Your Form","href":"/platform/interfaces/forms/sharing"},{"title":"Additional Features","href":"/platform/interfaces/forms/additional-features"},{"title":"Tracking Performance","href":"/platform/interfaces/forms/analytics"},{"title":"Reviewing Submissions","href":"/platform/interfaces/forms/submissions"}]},{"title":"Voicebots","href":"/platform/interfaces/voicebots"}]},{"group":"Portals","pages":[{"title":"Overview","href":"/platform/portals/overview"},{"title":"Creating a Portal","href":"/platform/portals/creating-a-portal"},{"title":"The Portal User Experience","href":"/platform/portals/portal-user-experience"},{"title":"Configuring a Portal","href":"/platform/portals/configuring-a-portal"},{"title":"Workspace","href":"/platform/portals/workspace"},{"title":"Deploying and Sharing a Portal","href":"/platform/portals/deploying-and-sharing"}]},{"group":"Marketplaces","pages":[{"title":"Overview","href":"/platform/marketplaces/overview"},{"title":"Publish to Marketplace","href":"/platform/marketplaces/publish"},{"title":"Ready-to-use templates","href":"/platform/marketplaces/templates"}]},{"title":"Transformations","href":"/platform/transformations"},{"title":"Files","href":"/platform/files"}]},{"group":"Nodes","pages":[{"group":"Start","pages":[{"title":"Input","href":"/nodes/input/overview"},{"title":"Output","href":"/nodes/output/overview"},{"title":"Start","href":"/nodes/start-node/overview"},{"title":"Trigger","href":"/nodes/trigger/overview"},{"title":"Browser Extension","href":"/nodes/browser-extension/overview"},{"title":"Note","href":"/nodes/note/overview"}]},{"group":"VectorShift","pages":[{"title":"Workflow Node","href":"/nodes/workflow/overview"},{"title":"Agent Node","href":"/nodes/agent/overview"}]},{"group":"Knowledge","pages":[{"title":"Knowledge Base Reader","href":"/nodes/knowledge-base-v3/overview"},{"title":"Create Knowledge Base","href":"/nodes/create-knowledge-base/overview"},{"title":"Knowledge Base Fetch Items","href":"/nodes/knowledge-base-fetch-items/overview"},{"title":"Knowledge Base Fetch Document Content","href":"/nodes/knowledge-base-fetch-document-content/overview"},{"title":"Knowledge Base Loader","href":"/nodes/knowledge-base-loader/overview"},{"title":"Sync Knowledge Base","href":"/nodes/sync-knowledge-base/overview"},{"title":"Knowledge Base Agent","href":"/nodes/knowledge-base-agent/overview"},{"title":"Semantic Search","href":"/nodes/semantic-search/overview"},{"title":"File","href":"/nodes/file/overview"},{"title":"File Save","href":"/nodes/file-save/overview"},{"title":"Create Workspace","href":"/nodes/create-workspace/overview"}]},{"group":"AI","pages":[{"title":"OpenAI LLM","href":"/nodes/openai/overview"},{"title":"Anthropic LLM","href":"/nodes/anthropic/overview"},{"title":"Google LLM","href":"/nodes/google/overview"},{"title":"Cohere LLM","href":"/nodes/cohere/overview"},{"title":"Custom LLM","href":"/nodes/custom/overview"},{"title":"Open Source LLM","href":"/nodes/open-source/overview"},{"title":"AWS Bedrock LLM","href":"/nodes/aws-bedrock/overview"},{"title":"xAI LLM","href":"/nodes/xai/overview"},{"title":"Perplexity LLM","href":"/nodes/perplexity/overview"},{"title":"Deep Research","href":"/nodes/deep-research/overview"},{"title":"Image to Image","href":"/nodes/image-to-image/overview"},{"title":"Text to Image","href":"/nodes/text-to-image/overview"},{"title":"Image to Text","href":"/nodes/image-to-text/overview"},{"title":"Speech to Text","href":"/nodes/speech-to-text/overview"},{"title":"Text to Speech","href":"/nodes/text-to-speech/overview"}]},{"group":"Logic","pages":[{"title":"Condition","href":"/nodes/condition/overview"},{"title":"AI Routing","href":"/nodes/ai-routing/overview"},{"title":"Merge - Pick First","href":"/nodes/merge-pick-first/overview"},{"title":"Merge - Join All","href":"/nodes/merge-join-all/overview"},{"title":"Set Variable","href":"/nodes/set-variable/overview"},{"title":"Code","href":"/nodes/code/overview"}]},{"group":"Chat","pages":[{"title":"Chat File Reader","href":"/nodes/chat-file-reader/overview"},{"title":"Chat Memory","href":"/nodes/chat-memory/overview"},{"title":"Create Session","href":"/nodes/create-session/overview"},{"title":"Data Collector","href":"/nodes/data-collector/overview"},{"title":"Listen — Button","href":"/nodes/listen-button/overview"},{"title":"Listen — Capture","href":"/nodes/listen-capture/overview"},{"title":"Post Message","href":"/nodes/post-message/overview"},{"title":"Talk — Message","href":"/nodes/talk-message/overview"},{"title":"Talk — Image","href":"/nodes/talk-image/overview"},{"title":"Talk — Card","href":"/nodes/talk-card/overview"},{"title":"Talk — Carousel","href":"/nodes/talk-carousel/overview"},{"title":"Read Session Messages","href":"/nodes/read-session-messages/overview"},{"title":"Get Run Data","href":"/nodes/get-run-data/overview"}]}]},{"group":"Account","pages":[{"title":"Profile","href":"/account/profile"},{"group":"Organizations","pages":[{"title":"Overview","href":"/account/organizations/overview"},{"title":"Enterprise Connections","href":"/account/organizations/enterprise-connections"}]},{"group":"Subscriptions","pages":[{"title":"Overview","href":"/account/subscriptions/overview"},{"title":"Personal Subscriptions","href":"/account/subscriptions/personal"},{"title":"Organization Subscriptions","href":"/account/subscriptions/organization"}]}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/overview"}]},{"tab":"SDK","pages":[{"title":"SDK","href":"/sdk"}]}]},"basePath":"","title":"Tips and Best Practices - VectorShift","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["a74be98ba7"],"chunks":["zoom-image-lightbox-BG6oD64b.js","lightbox-handle-r17bVUz3.js"]}