Tool · Discovery

Search tool documentation

Search available Aroai tool descriptions and skills to find a relevant capability.

Start building free Connect your client

Published tool ID

search_docs

Search available Aroai tool descriptions and skills to find a relevant capability.

ServerAroai Core

SourceAroai public catalog

Credit behaviorFree

AccessWorkspace permissions

Inputs and outputs

Published input schema

Use the discovered runtime schema for the workspace you are connected to.

Public catalog

search_docs input schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "required": [
    "query",
    "limit"
  ],
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 20,
      "default": 5
    }
  },
  "additionalProperties": false
}

Published output shape

Tool results return structured data or a stable error object.

Shared Aroai tool output schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "summary": {
          "type": "string"
        },
        "data": {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {}
        },
        "executionId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "creditsCharged": {
          "type": "number",
          "minimum": 0
        }
      },
      "required": [
        "summary",
        "data",
        "creditsCharged"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "code": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "retryable": {
              "type": "boolean"
            }
          },
          "required": [
            "code",
            "message",
            "retryable"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "error"
      ],
      "additionalProperties": false
    }
  ]
}

Source and usage notes

Understand the result boundary

No credits are charged.
The default result limit is five and the maximum is twenty.

View sources and coverage

Use this capability

Put the tool in a complete workflow.

Follow a recipe that explains the input, sequence, result and human review points.

Open a recipe Client setup

Local intelligence. Ready to build.

Start with a task you can inspect.

Connect a compatible client, choose a workflow and review the source fields that come back.

Start building free Explore tools