Octri

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

querystringrequired

What to look for, in plain words.

limitnumberdefault: 5

How many results to return.

projectIdstring

The 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.

HintValueWhen true, it means
readOnlyHinttrueIt doesn't change anything
destructiveHintfalseIt can change or delete data
idempotentHinttrueCalling it twice does no more than once
openWorldHinttrueIt reaches outside the server, over the network

Examples

Find an endpoint

Call
{
  "name": "search_docs",
  "arguments": {
    "query": "create a customer"
  }
}
Result
1. **Create a customer** `POST /customers`
   Slug: `post-customers`

Find a guide

Run against these docs, which have guides.

Call
{
  "name": "search_docs",
  "arguments": {
    "query": "tool groups",
    "limit": 3
  }
}
Result
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`