Agentic Platform
Documentation API reference Tools Skills

Tools

Tool Documentation

tool_documentation MCP

Load extended markdown documentation for a dinosaur tool by id.

Return the sidecar documentation.md of another tool. Use this when a tool's short description is not enough (for example the JavaScript DOM API of html_code_executor). Select the tool from the tool_name enum.

Playground

POST
item
tool_name required

Id of the tool to document.

Credits

Fixed cost per item requested. Documentation is served from Botify, so there is nothing to bill beyond the per-call price.

These usage SKUs can be charged on a call.

SKU Credits Description
Tool call 1 per request Charged once per successful item.

Schemas

item is what you send, config how the tool behaves, and the response is what you get back.

Item

object
Properties
tool_name string required

Id of the tool to document.

Example
{
  "tool_name": "html_code_executor"
}

Response

object

Output from the tool_documentation agent.

Properties
tool_name string required

Resolved tool id (batch suffix stripped).

documentation string | null

Extended markdown documentation, if any.

Default: null

error string | null

Set when the tool is unknown or has no extended documentation.

Default: null

Example
{
  "tool_name": "string",
  "documentation": null,
  "error": null
}

Endpoints

POST http://agents.botify.com/{organization}/{project}/tool_documentation/process
POST http://agents.botify.com/{organization}/{project}/tool_documentation/batch_process
POST http://agents.botify.com/{organization}/{project}/tool_documentation/async_process
POST http://agents.botify.com/{organization}/{project}/tool_documentation/async_batch_process

See running a long job in the background for the polling flow.

cURL

curl -X POST "http://agents.botify.com/{organization}/{project}/tool_documentation/process" \
  -H "Authorization: Bearer $BOTIFY_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "item": {
    "tool_name": "<tool_name>"
  }
}'

Over MCP

This tool is exposed as the MCP tool tool_documentation. An MCP client passes organization, project and item as tool arguments. Set up MCP →

Raw metadata