Octri

list_endpoints

Lists every page in your docs' sidebar: endpoints and guides, by section. A map of what the docs cover, for an agent that wants to look around rather than search. It follows your docs' sidebar, so pages you've hidden aren't listed.

When it's listed

On every server, in every tool mode. A tool group can leave the documentation tools out.

Arguments

sectionstring

Only the sections whose title contains this, ignoring case.

projectIdstring

The project to read. Leave it out: the server already knows its project, and passing another one reads that project instead.

Returns

A heading per section, then a line per page with its slug. An endpoint shows its method and path, and a guide in a section shows its groupSlug too.

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

One section

Call
{
  "name": "list_endpoints",
  "arguments": {
    "section": "invoices"
  }
}
Result
### Invoices
  - **List invoices** `GET /invoices` (slug: `get-invoices`)
  - **Retrieve an invoice** `GET /invoices/{invoiceId}` (slug: `get-invoices-invoiceid`)
  - **Email an invoice** `POST /invoices/{invoiceId}/send` (slug: `post-invoices-invoiceid-send`)