[{"data":1,"prerenderedAt":754},["ShallowReactive",2],{"docs-navigation":3,"docs-\u002Fdocs\u002Fmcp\u002Fsetup":331,"docs-\u002Fdocs\u002Fmcp\u002Fsetup-surround":751},[4],{"title":5,"path":6,"stem":7,"children":8,"page":46},"Docs","\u002Fdocs","docs",[9,47,72,90,132,198,241,252,276,301],{"title":10,"description":11,"icon":12,"path":13,"stem":14,"children":15,"page":46},"Getting started","What Zaproo Search is, a quickstart, and wiring search into a storefront.","i-lucide-rocket","\u002Fdocs\u002Fgetting-started","docs\u002F1.getting-started",[16,22,28,34,40],{"title":17,"path":18,"stem":19,"description":20,"icon":21},"Introduction","\u002Fdocs\u002Fgetting-started\u002Fintroduction","docs\u002F1.getting-started\u002F1.introduction","What Zaproo Search is, the five things you work with, and how a product catalog becomes a search box on your shop.","i-lucide-book-open-text",{"title":23,"path":24,"stem":25,"description":26,"icon":27},"Quickstart","\u002Fdocs\u002Fgetting-started\u002Fquickstart","docs\u002F1.getting-started\u002F2.quickstart","Set up search for your shop in the cabinet, from a new account to a first search, with the API and MCP as other ways to do the same.","i-lucide-zap",{"title":29,"path":30,"stem":31,"description":32,"icon":33},"Integrate a storefront","\u002Fdocs\u002Fgetting-started\u002Fstorefront","docs\u002F1.getting-started\u002F3.storefront","Build a search results page with facets and an autocomplete box on top of the search and suggest routes.","i-lucide-store",{"title":35,"path":36,"stem":37,"description":38,"icon":39},"JavaScript SDK","\u002Fdocs\u002Fgetting-started\u002Fjavascript-sdk","docs\u002F1.getting-started\u002F4.javascript-sdk","Search, autocomplete and event tracking from a storefront with one small client that runs in the browser, on your server and in edge functions.","i-lucide-braces",{"title":41,"path":42,"stem":43,"description":44,"icon":45},"AI shopping assistant","\u002Fdocs\u002Fgetting-started\u002Fai-assistant","docs\u002F1.getting-started\u002F5.ai-assistant","A chat widget for your storefront that finds products and answers questions from your indexes.","i-lucide-sparkles",false,{"title":48,"description":49,"icon":50,"path":51,"stem":52,"children":53,"page":46},"Account and team","Sign-in, sessions, organizations, members, roles and projects.","i-lucide-users","\u002Fdocs\u002Faccount","docs\u002F2.account",[54,60,66],{"title":55,"path":56,"stem":57,"description":58,"icon":59},"Account and sign-in","\u002Fdocs\u002Faccount\u002Fsign-in","docs\u002F2.account\u002F1.sign-in","Create an account, verify your email, stay signed in, manage signed-in devices and change or reset your password.","i-lucide-log-in",{"title":61,"path":62,"stem":63,"description":64,"icon":65},"Organizations, members and roles","\u002Fdocs\u002Faccount\u002Forganizations","docs\u002F2.account\u002F2.organizations","What an organization holds, how to add members, and what owners, admins and members may do.","i-lucide-building-2",{"title":67,"path":68,"stem":69,"description":70,"icon":71},"Projects","\u002Fdocs\u002Faccount\u002Fprojects","docs\u002F2.account\u002F3.projects","Group the indices and API keys of one shop or one environment, and keep staging apart from production.","i-lucide-folder-kanban",{"title":73,"description":74,"icon":75,"path":76,"stem":77,"children":78,"page":46},"API keys and security","Secret and public keys, scopes, allowed origins, rate limits and errors.","i-lucide-key-round","\u002Fdocs\u002Fkeys","docs\u002F3.keys",[79,84],{"title":80,"path":81,"stem":82,"description":83,"icon":75},"API keys","\u002Fdocs\u002Fkeys\u002Fapi-keys","docs\u002F3.keys\u002F1.api-keys","Secret and public keys, full and read access, index scope, allowed origins, expiry, and how to revoke a key.",{"title":85,"path":86,"stem":87,"description":88,"icon":89},"Rate limits and errors","\u002Fdocs\u002Fkeys\u002Frate-limits","docs\u002F3.keys\u002F2.rate-limits","How many requests each route accepts per minute, what a 429 looks like, the error format and every error code with its HTTP status.","i-lucide-gauge",{"title":91,"description":92,"icon":93,"path":94,"stem":95,"children":96,"page":46},"Indexing","Indices, languages, mappings, documents, tasks, full catalog sync and reindexing.","i-lucide-database","\u002Fdocs\u002Findexing","docs\u002F4.indexing",[97,102,108,114,120,126],{"title":98,"path":99,"stem":100,"description":101,"icon":93},"Indices and languages","\u002Fdocs\u002Findexing\u002Findices","docs\u002F4.indexing\u002F1.indices","Create an index, pick its language, read its status, and change the language later with a reindex.",{"title":103,"path":104,"stem":105,"description":106,"icon":107},"Mapping and fields","\u002Fdocs\u002Findexing\u002Fmapping","docs\u002F4.indexing\u002F2.mapping","Field types, the five flags that decide what a field is used for, text analysis options, unmapped fields, and which changes need a reindex.","i-lucide-table-properties",{"title":109,"path":110,"stem":111,"description":112,"icon":113},"Documents and tasks","\u002Fdocs\u002Findexing\u002Fdocuments","docs\u002F4.indexing\u002F3.documents","Upload, browse and delete documents in the cabinet or through the API, follow each write as a task, and retry safely with Idempotency-Key.","i-lucide-file-json",{"title":115,"path":116,"stem":117,"description":118,"icon":119},"Full catalog sync","\u002Fdocs\u002Findexing\u002Ffull-sync","docs\u002F4.indexing\u002F4.full-sync","Replace the whole catalog with a replace session, so products missing from your export disappear from search, without downtime.","i-lucide-refresh-cw",{"title":121,"path":122,"stem":123,"description":124,"icon":125},"Reindex and versions","\u002Fdocs\u002Findexing\u002Fversions","docs\u002F4.indexing\u002F5.versions","Rebuild an index with its saved mapping and swap it in without downtime, follow or cancel the rebuild, and read activeVersion and buildingVersion.","i-lucide-git-compare-arrows",{"title":127,"path":128,"stem":129,"description":130,"icon":131},"Data source","\u002Fdocs\u002Findexing\u002Fdata-source","docs\u002F4.indexing\u002F6.data-source","Let Zaproo download your product feed on a schedule, map it to documents, write only what changed and delete what left the feed.","i-lucide-rss",{"title":133,"description":134,"icon":135,"path":136,"stem":137,"children":138,"page":46},"Integrations","Connect your shop. Magento 2, product feeds and the API work today; more platforms are coming.","i-lucide-plug-zap","\u002Fdocs\u002Fintegrations","docs\u002F4.integrations",[139,145,151,156,162,168,173,178,183,188,193],{"title":140,"path":141,"stem":142,"description":143,"icon":144},"Integrations overview","\u002Fdocs\u002Fintegrations\u002Foverview","docs\u002F4.integrations\u002F01.overview","The ways to get your catalog into Zaproo Search, which one to pick, and how a connected shop shows up in the cabinet.","i-lucide-layout-grid",{"title":146,"path":147,"stem":148,"description":149,"icon":150},"Magento 2","\u002Fdocs\u002Fintegrations\u002Fmagento","docs\u002F4.integrations\u002F02.magento","Install the Zaproo Search module for Magento 2, connect each store view to its own index, and keep the catalog in sync.","i-lucide-shopping-cart",{"title":152,"path":153,"stem":154,"description":155,"icon":131},"Product feed","\u002Fdocs\u002Fintegrations\u002Fproduct-feed","docs\u002F4.integrations\u002F03.product-feed","Connect any shop that can publish its catalog as a feed. You set it up in the cabinet, and Zaproo downloads the feed on a schedule and writes only what changed.",{"title":157,"path":158,"stem":159,"description":160,"icon":161},"REST API and MCP","\u002Fdocs\u002Fintegrations\u002Frest-api-and-mcp","docs\u002F4.integrations\u002F04.rest-api-and-mcp","Send documents from your own code with the REST API, or let an AI agent manage the index over MCP.","i-lucide-code",{"title":163,"path":164,"stem":165,"description":166,"icon":167},"Shopify","\u002Fdocs\u002Fintegrations\u002Fshopify","docs\u002F4.integrations\u002F05.shopify","A Zaproo Search integration for Shopify is coming soon. Until then, connect the shop through a product feed or the REST API.","i-lucide-shopping-bag",{"title":169,"path":170,"stem":171,"description":172,"icon":167},"WooCommerce","\u002Fdocs\u002Fintegrations\u002Fwoocommerce","docs\u002F4.integrations\u002F06.woocommerce","A Zaproo Search integration for WooCommerce is coming soon. Until then, connect the shop through a product feed or the REST API.",{"title":174,"path":175,"stem":176,"description":177,"icon":167},"Shopware","\u002Fdocs\u002Fintegrations\u002Fshopware","docs\u002F4.integrations\u002F07.shopware","A Zaproo Search integration for Shopware is coming soon. Until then, connect the shop through a product feed or the REST API.",{"title":179,"path":180,"stem":181,"description":182,"icon":167},"BigCommerce","\u002Fdocs\u002Fintegrations\u002Fbigcommerce","docs\u002F4.integrations\u002F08.bigcommerce","A Zaproo Search integration for BigCommerce is coming soon. Until then, connect the shop through a product feed or the REST API.",{"title":184,"path":185,"stem":186,"description":187,"icon":167},"PrestaShop","\u002Fdocs\u002Fintegrations\u002Fprestashop","docs\u002F4.integrations\u002F09.prestashop","A Zaproo Search integration for PrestaShop is coming soon. Until then, connect the shop through a product feed or the REST API.",{"title":189,"path":190,"stem":191,"description":192,"icon":167},"commercetools","\u002Fdocs\u002Fintegrations\u002Fcommercetools","docs\u002F4.integrations\u002F10.commercetools","A Zaproo Search integration for commercetools is coming soon. Until then, connect the shop through a product feed or the REST API.",{"title":194,"path":195,"stem":196,"description":197,"icon":167},"Salesforce Commerce Cloud","\u002Fdocs\u002Fintegrations\u002Fsalesforce-commerce-cloud","docs\u002F4.integrations\u002F11.salesforce-commerce-cloud","A Zaproo Search integration for Salesforce Commerce Cloud is coming soon. Until then, connect the shop through a product feed or the REST API.",{"title":199,"description":200,"icon":201,"path":202,"stem":203,"children":204,"page":46},"Search and relevance","The search API, search profiles, facets, synonyms and ranking rules.","i-lucide-search","\u002Fdocs\u002Fsearch","docs\u002F5.search",[205,211,217,223,229,235],{"title":206,"path":207,"stem":208,"description":209,"icon":210},"Search API","\u002Fdocs\u002Fsearch\u002Fsearch-api","docs\u002F5.search\u002F1.search-api","Try a search in the playground, then the search request and response for developers, with every filter form, sorting, paging, highlighting and the inline profile.","i-lucide-search-code",{"title":212,"path":213,"stem":214,"description":215,"icon":216},"Search profiles","\u002Fdocs\u002Fsearch\u002Fprofiles","docs\u002F5.search\u002F2.profiles","Every setting of a search profile, what it does to results, and the mistakes to avoid.","i-lucide-sliders-horizontal",{"title":218,"path":219,"stem":220,"description":221,"icon":222},"Facets","\u002Fdocs\u002Fsearch\u002Ffacets","docs\u002F5.search\u002F3.facets","The filter panels next to the results, the four facet types, index facets and profile facets, and how a shopper's clicks change the counts.","i-lucide-list-filter",{"title":224,"path":225,"stem":226,"description":227,"icon":228},"Synonyms","\u002Fdocs\u002Fsearch\u002Fsynonyms","docs\u002F5.search\u002F4.synonyms","Let different words find the same products, with equivalent and one-way rules, bulk import and export in the Solr format, and no reindex.","i-lucide-arrow-left-right",{"title":230,"path":231,"stem":232,"description":233,"icon":234},"Ranking rules","\u002Fdocs\u002Fsearch\u002Frules","docs\u002F5.search\u002F5.rules","Change the results for chosen searches. Put products first, hide them, lift or lower a brand, narrow the results or weigh fields differently, on a schedule and per profile.","i-lucide-list-ordered",{"title":236,"path":237,"stem":238,"description":239,"icon":240},"Language groups","\u002Fdocs\u002Fsearch\u002Flanguage-groups","docs\u002F5.search\u002F6.language-groups","Let each store of a multilingual shop find its products by the other stores' text, so an English search on the Estonian store still finds the Estonian product.","i-lucide-languages",{"title":242,"description":243,"icon":244,"path":245,"stem":246,"children":247,"page":46},"Autocomplete","Query suggestions as the shopper types.","i-lucide-text-cursor-input","\u002Fdocs\u002Fautocomplete","docs\u002F6.autocomplete",[248],{"title":242,"path":249,"stem":250,"description":251,"icon":244},"\u002Fdocs\u002Fautocomplete\u002Fsuggestions","docs\u002F6.autocomplete\u002F1.suggestions","Set up query suggestions in the cabinet. They are built every hour from your shoppers' searches, field values and custom entries.",{"title":253,"description":254,"icon":255,"path":256,"stem":257,"children":258,"page":46},"Analytics","Searches, zero-result queries and latency.","i-lucide-chart-line","\u002Fdocs\u002Fanalytics","docs\u002F7.analytics",[259,264,270],{"title":260,"path":261,"stem":262,"description":263,"icon":255},"Search analytics","\u002Fdocs\u002Fanalytics\u002Fsearch-analytics","docs\u002F7.analytics\u002F1.search-analytics","What the analytics page counts, which traffic it leaves out, how the headline numbers are defined, how comparisons and retention work, and how to get the weekly digest.",{"title":265,"path":266,"stem":267,"description":268,"icon":269},"Reports","\u002Fdocs\u002Fanalytics\u002Freports","docs\u002F7.analytics\u002F2.reports","Every analytics report with the definition of each column, the opportunities list and its fix buttons, the per-query view with before and after, and the CSV download.","i-lucide-table",{"title":271,"path":272,"stem":273,"description":274,"icon":275},"Event tracking","\u002Fdocs\u002Fanalytics\u002Fevent-tracking","docs\u002F7.analytics\u002F3.event-tracking","Send clicks, add-to-cart, purchases and suggestion clicks from your storefront, tie them to the search with searchId, and a copy-paste script that does it.","i-lucide-mouse-pointer-click",{"title":277,"description":278,"icon":279,"path":280,"stem":281,"children":282,"page":46},"AI agents (MCP)","Connect Claude Code or any MCP client and manage search from an agent.","i-lucide-bot","\u002Fdocs\u002Fmcp","docs\u002F8.mcp",[283,289,295],{"title":284,"path":285,"stem":286,"description":287,"icon":288},"MCP setup","\u002Fdocs\u002Fmcp\u002Fsetup","docs\u002F8.mcp\u002F1.setup","Connect Claude Code or another MCP client to your project from the cabinet's MCP connection page, and let an agent manage indices, documents, profiles, synonyms and rules.","i-lucide-plug",{"title":290,"path":291,"stem":292,"description":293,"icon":294},"MCP tools","\u002Fdocs\u002Fmcp\u002Ftools","docs\u002F8.mcp\u002F2.tools","Every tool the Zaproo Search MCP server offers, what an agent can do with each group, and prompts to start from.","i-lucide-wrench",{"title":296,"path":297,"stem":298,"description":299,"icon":300},"Resources and prompts","\u002Fdocs\u002Fmcp\u002Fresources","docs\u002F8.mcp\u002F3.resources","The index resources an MCP client can read, the tune_relevance prompt, and the errors the MCP server answers.","i-lucide-library",{"title":302,"description":303,"icon":304,"path":305,"stem":306,"children":307,"page":46},"Reference","Every REST route, every limit, plans and billing, and status.","i-lucide-book-open","\u002Fdocs\u002Freference","docs\u002F9.reference",[308,314,319,325],{"title":309,"path":310,"stem":311,"description":312,"icon":313},"REST API","\u002Fdocs\u002Freference\u002Frest-api","docs\u002F9.reference\u002F1.rest-api","The routes of the Zaproo Search REST API, grouped by area, with who may call it.","i-lucide-list-tree",{"title":315,"path":316,"stem":317,"description":318,"icon":89},"Limits","\u002Fdocs\u002Freference\u002Flimits","docs\u002F9.reference\u002F2.limits","Every size limit, cap and default of the Zaproo Search API in one place, with what happens when you reach it.",{"title":320,"path":321,"stem":322,"description":323,"icon":324},"Plans and billing","\u002Fdocs\u002Freference\u002Fbilling","docs\u002F9.reference\u002F3.billing","Check your plan and usage on the Billing & usage page, change the plan, download invoices, and see how quotas and proration work.","i-lucide-credit-card",{"title":326,"path":327,"stem":328,"description":329,"icon":330},"Status","\u002Fdocs\u002Freference\u002Fstatus","docs\u002F9.reference\u002F4.status","The status page and the status route, what each service covers and how to use them in your own monitoring.","i-lucide-activity",{"id":332,"title":284,"body":333,"description":287,"extension":746,"meta":747,"navigation":748,"path":285,"seo":749,"stem":286,"__hash__":750},"docs\u002Fdocs\u002F8.mcp\u002F1.setup.md",{"type":334,"value":335,"toc":734},"minimark",[336,341,350,358,362,562,566,573,670,674,685,694,697,703,707,730],[337,338,340],"h2",{"id":339},"what-mcp-gives-you","What MCP gives you",[342,343,344,345,349],"p",{},"MCP (Model Context Protocol) lets an AI agent such as Claude Code work on your project for you. You ask in plain words, for example \"add a synonym so that scotch finds tape\", and the agent calls the matching ",[346,347,348],"a",{"href":291},"tool",". It sees the same project and follows the same rules as the cabinet, and its changes show up in the cabinet like anything you set up by hand.",[342,351,352,353,357],{},"The MCP server is part of the API, at ",[354,355,356],"code",{},"https:\u002F\u002Fapi.search.zaproo.cloud\u002Fmcp",". It uses the same secret keys as the REST API. The key's project is the project every tool acts on, and a key limited to some indices reaches only those.",[337,359,361],{"id":360},"connect-claude-code","Connect Claude Code",[363,364,366,371,386,394,398,419,435,449,457,468,472,482,526,530,533,541],"steps",{"level":365},"3",[367,368,370],"h3",{"id":369},"open-the-mcp-connection-page","Open the MCP connection page",[342,372,373,374,378,379,381,382,385],{},"Open the project and click ",[375,376,377],"strong",{},"MCP connection"," in the project menu. The page shows the endpoint, a ready-made command under ",[375,380,361],{},", and the list of tools under ",[375,383,384],{},"Tools",".",[342,387,388],{},[389,390],"img",{"alt":391,"src":392,"title":393},"The MCP connection page of the Default project with the endpoint, the Connect Claude Code box holding the claude mcp add command and a Copy button, and the start of the Tools table","\u002Fdocs\u002Fscreenshots\u002Fmcp.png","The command on this page already holds your endpoint",[367,395,397],{"id":396},"create-a-secret-key","Create a secret key",[342,399,400,401,404,405,407,408,410,411,414,415,418],{},"Click the ",[375,402,403],{},"secret key"," link in the ",[375,406,361],{}," box, or open ",[375,409,80],{}," in the project menu. Click ",[375,412,413],{},"New key",", pick the type ",[375,416,417],{},"Secret key (sk), server side"," and the access you want to give the agent:",[420,421,422,429],"ul",{},[423,424,425,428],"li",{},[375,426,427],{},"Full access"," lets the agent change things: upload documents, save profiles, add synonyms and rules.",[423,430,431,434],{},[375,432,433],{},"Read only"," lets it look and search but change nothing. The agent can still propose changes for you to make.",[342,436,437,438,441,442,445,446,385],{},"Click ",[375,439,440],{},"Create key"," and copy the key (",[354,443,444],{},"zs_sk_...","). It is shown only once. Creating keys needs a verified email and the owner or admin role. See ",[346,447,80],{"href":448},"\u002Fdocs\u002Fkeys\u002Fapi-keys#create-a-key",[342,450,451,452,456],{},"The cabinet form has no field for an index scope. To keep an agent on one catalog, set the key's ",[346,453,455],{"href":454},"\u002Fdocs\u002Fkeys\u002Fapi-keys#index-scope","index scope"," through the API.",[342,458,459,460,463,464,385],{},"Public keys (",[354,461,462],{},"zs_pk_...",") don't work for MCP. The server refuses them; see ",[346,465,467],{"href":466},"\u002Fdocs\u002Fmcp\u002Fresources#errors","errors",[367,469,471],{"id":470},"run-the-command","Run the command",[342,473,437,474,477,478,481],{},[375,475,476],{},"Copy"," next to the command, paste it into your terminal and replace ",[354,479,480],{},"zs_sk_YOUR_KEY"," with the key you just created:",[483,484,489],"pre",{"className":485,"code":486,"language":487,"meta":488,"style":488},"language-bash shiki shiki-themes github-light-high-contrast github-light-high-contrast github-dark-high-contrast","claude mcp add --transport http zaproo-search https:\u002F\u002Fapi.search.zaproo.cloud\u002Fmcp --header \"Authorization: Bearer zs_sk_YOUR_KEY\"\n","bash","",[354,490,491],{"__ignoreMap":488},[492,493,496,500,504,507,511,514,517,520,523],"span",{"class":494,"line":495},"line",1,[492,497,499],{"class":498},"szw1H","claude",[492,501,503],{"class":502},"semJd"," mcp",[492,505,506],{"class":502}," add",[492,508,510],{"class":509},"ssYy9"," --transport",[492,512,513],{"class":502}," http",[492,515,516],{"class":502}," zaproo-search",[492,518,519],{"class":502}," https:\u002F\u002Fapi.search.zaproo.cloud\u002Fmcp",[492,521,522],{"class":509}," --header",[492,524,525],{"class":502}," \"Authorization: Bearer zs_sk_YOUR_KEY\"\n",[367,527,529],{"id":528},"ask-the-agent-something","Ask the agent something",[342,531,532],{},"Start Claude Code and try a request that only reads:",[483,534,539],{"className":535,"code":537,"language":538,"meta":488},[536],"language-text","List the indices of my Zaproo project and show the mapping of the products index.\n","text",[354,540,537],{"__ignoreMap":488},[342,542,543,544,547,548,551,552,555,556,559,560,385],{},"The agent calls ",[354,545,546],{},"list_indices"," and ",[354,549,550],{},"get_mapping",". If it reports a ",[354,553,554],{},"401"," or ",[354,557,558],{},"403",", check the key; see ",[346,561,467],{"href":466},[337,563,565],{"id":564},"connect-another-mcp-client","Connect another MCP client",[342,567,568,569,572],{},"Any client that speaks MCP over Streamable HTTP works. Add the server to the client's configuration with the endpoint and the secret key in an ",[354,570,571],{},"Authorization"," header:",[483,574,578],{"className":575,"code":576,"language":577,"meta":488,"style":488},"language-json shiki shiki-themes github-light-high-contrast github-light-high-contrast github-dark-high-contrast","{\n  \"mcpServers\": {\n    \"zaproo-search\": {\n      \"type\": \"http\",\n      \"url\": \"https:\u002F\u002Fapi.search.zaproo.cloud\u002Fmcp\",\n      \"headers\": { \"Authorization\": \"Bearer zs_sk_YOUR_KEY\" }\n    }\n  }\n}\n","json",[354,579,580,586,596,604,619,632,652,658,664],{"__ignoreMap":488},[492,581,582],{"class":494,"line":495},[492,583,585],{"class":584},"s7iLA","{\n",[492,587,589,593],{"class":494,"line":588},2,[492,590,592],{"class":591},"sb7M8","  \"mcpServers\"",[492,594,595],{"class":584},": {\n",[492,597,599,602],{"class":494,"line":598},3,[492,600,601],{"class":591},"    \"zaproo-search\"",[492,603,595],{"class":584},[492,605,607,610,613,616],{"class":494,"line":606},4,[492,608,609],{"class":591},"      \"type\"",[492,611,612],{"class":584},": ",[492,614,615],{"class":502},"\"http\"",[492,617,618],{"class":584},",\n",[492,620,622,625,627,630],{"class":494,"line":621},5,[492,623,624],{"class":591},"      \"url\"",[492,626,612],{"class":584},[492,628,629],{"class":502},"\"https:\u002F\u002Fapi.search.zaproo.cloud\u002Fmcp\"",[492,631,618],{"class":584},[492,633,635,638,641,644,646,649],{"class":494,"line":634},6,[492,636,637],{"class":591},"      \"headers\"",[492,639,640],{"class":584},": { ",[492,642,643],{"class":591},"\"Authorization\"",[492,645,612],{"class":584},[492,647,648],{"class":502},"\"Bearer zs_sk_YOUR_KEY\"",[492,650,651],{"class":584}," }\n",[492,653,655],{"class":494,"line":654},7,[492,656,657],{"class":584},"    }\n",[492,659,661],{"class":494,"line":660},8,[492,662,663],{"class":584},"  }\n",[492,665,667],{"class":494,"line":666},9,[492,668,669],{"class":584},"}\n",[337,671,673],{"id":672},"what-the-agent-can-do","What the agent can do",[342,675,676,677,680,681,385],{},"Each tool runs the same service as the matching REST route, with the same checks and the same audit log. Writes to documents are asynchronous: they return a task id, and ",[354,678,679],{},"get_task"," tells when the work is done. Some work has no tool and stays in the cabinet, such as API keys, members and billing. See ",[346,682,684],{"href":683},"\u002Fdocs\u002Fmcp\u002Ftools#what-the-tools-do-not-cover","What the tools do not cover",[342,686,687,688,690,691,693],{},"The table below matches the ",[375,689,384],{}," list on the ",[375,692,377],{}," page.",[695,696],"mcp-tools",{},[342,698,699,700,702],{},"To stop an agent, revoke its key on the ",[375,701,80],{}," page. The next request it sends is refused.",[337,704,706],{"id":705},"related","Related",[420,708,709,713,717,721,726],{},[423,710,711],{},[346,712,290],{"href":291},[423,714,715],{},[346,716,296],{"href":297},[423,718,719],{},[346,720,80],{"href":81},[423,722,723],{},[346,724,23],{"href":725},"\u002Fdocs\u002Fgetting-started\u002Fquickstart#with-an-ai-agent",[423,727,728],{},[346,729,157],{"href":158},[731,732,733],"style",{},"html pre.shiki code .szw1H, html code.shiki .szw1H{--shiki-light:#702C00;--shiki-default:#702C00;--shiki-dark:#FFB757}html pre.shiki code .semJd, html code.shiki .semJd{--shiki-light:#032563;--shiki-default:#032563;--shiki-dark:#ADDCFF}html pre.shiki code .ssYy9, html code.shiki .ssYy9{--shiki-light:#023B95;--shiki-default:#023B95;--shiki-dark:#91CBFF}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .s7iLA, html code.shiki .s7iLA{--shiki-light:#0E1116;--shiki-default:#0E1116;--shiki-dark:#F0F3F6}html pre.shiki code .sb7M8, html code.shiki .sb7M8{--shiki-light:#024C1A;--shiki-default:#024C1A;--shiki-dark:#72F088}",{"title":488,"searchDepth":588,"depth":588,"links":735},[736,737,743,744,745],{"id":339,"depth":588,"text":340},{"id":360,"depth":588,"text":361,"children":738},[739,740,741,742],{"id":369,"depth":598,"text":370},{"id":396,"depth":598,"text":397},{"id":470,"depth":598,"text":471},{"id":528,"depth":598,"text":529},{"id":564,"depth":588,"text":565},{"id":672,"depth":588,"text":673},{"id":705,"depth":588,"text":706},"md",{},{"icon":288},{"title":284,"description":287},"ZbsAV5n_8tbxMD8gdW8efJmnvIWgz0RlYA0Xu757M0c",[752,753],{"title":271,"path":272,"stem":273,"description":274,"icon":275,"children":-1},{"title":290,"path":291,"stem":292,"description":293,"icon":294,"children":-1},1793717706325]