search_docs
Searches your published documentation, endpoints and guides, for a phrase. The tool an agent usually starts with: it turns a task, such as "create a customer", into the pages that cover it. Each result carries what the agent needs to read the page next.
When it's listed
On every server, in every tool mode. A tool group can leave the documentation tools out.
Arguments
querystringrequiredWhat to look for, in plain words.
limitnumberHow many results to return.
projectIdstringThe project to read. Leave it out: the server already knows its project, and passing another one reads that project instead.
Returns
A numbered list, best match first. An endpoint shows its method and path, and a guide is marked (guide). Each result ends with the slug to read it by: get_endpoint takes an endpoint's, and get_guide takes a guide's slug and its groupSlug.
Hints
The annotations a client reads to decide what may run without asking the user.
| Hint | Value | When true, it means |
|---|---|---|
readOnlyHint | true | It doesn't change anything |
destructiveHint | false | It can change or delete data |
idempotentHint | true | Calling it twice does no more than once |
openWorldHint | true | It reaches outside the server, over the network |
Examples
Find an endpoint
{
"name": "search_docs",
"arguments": {
"query": "create a customer"
}
}1. **Create a customer** `POST /customers`
Slug: `post-customers`Find a guide
Run against these docs, which have guides.
{
"name": "search_docs",
"arguments": {
"query": "tool groups",
"limit": 3
}
}1. **Overview** (guide)
Slug: `overview`, groupSlug: `mcp`
2. **Permissions and limits** (guide)
Slug: `controls`, groupSlug: `mcp`
3. **Customizing tools** (guide)
Slug: `customizing-tools`, groupSlug: `mcp`Related
- Documentation tools:
get_endpoint,list_endpoints,get_guide,get_sdk_methods,list_sdks,get_changelog. - Documentation tools: how agents use these together.
- Search and AI chat: the same search, for people on your docs site.