---
title: "List tools"
method: GET
path: "/v1/tools"
tags: ["tools"]
---

# List tools

`GET /v1/tools`

## Request

- Base URL: `https://api.pomerado.ai`
- URL: `https://api.pomerado.ai/v1/tools`
- Auth: HTTP bearer

List or search the tools you can run: public tools and your own private ones.

- Each tool has its input and output schemas, effect, sign-in needs and integration. Disabled tools are never listed.
- An integration key lists only its integration's tools.
- Without credentials, where allowed, only public read-only tools that need no login are listed. A notice says that signing up (free) or signing in adds tools that write, saved logins and building tools, and how to do it.

## Query parameters

- `cursor` string
- `limit` string
- `query` string
- `site_url` string
- `integration_id` string

## Response `200`

One page of tools

- object
  - `data` Tool[], required
    - `id` string, required: a tool ID: tool_ and 32 lowercase hex digits
    - `name` string, required
    - `description` string, required
    - `integration_id` string, required: an integration ID: int_ and 32 lowercase hex digits
    - `site` object, nullable, required
      - `url` string, required: The site's https origin
      - `name` string, required: The site's everyday name
    - `effect` 'read' | 'write', required: read changes nothing on the site; write changes something there
    - `input_schema` object, required: What a run's input takes, as JSON Schema. References are resolved: one left in a recursive schema points at its root $defs
    - `output_schema` object, required: What a succeeded run's result holds, as JSON Schema, in the same form
    - `login` object, nullable, required: What its sign-in takes; null when it needs none
      - `fields` string[], required: The login fields a run may carry for its sign-in
      - `two_factor_methods` string[], required: Second steps its recorded sign-in offered; empty when none was recorded
    - `mcp_name` string, required: Its tool name on its integration's MCP, such as get_claim_status
    - `can_change` boolean, required: Whether you can request a change to this tool: you can run it and build tools, and you aren't using an integration key
    - `egress` object: Its location: only on your Business account's private tools, where Pomerado offers it
      - `location` 'US' | 'GB' | 'FR' | 'DE' | 'SG', required: The country websites see its builds, changes and runs coming from, unless a run names another
  - `next_cursor` string, nullable, required
  - `possible_matches` Tool[]: With query and site_url, on the first page: up to 50 of the site's other tools that may cover the task. Compare them before building another.
    - `id` string, required: a tool ID: tool_ and 32 lowercase hex digits
    - `name` string, required
    - `description` string, required
    - `integration_id` string, required: an integration ID: int_ and 32 lowercase hex digits
    - `site` object, nullable, required
      - `url` string, required: The site's https origin
      - `name` string, required: The site's everyday name
    - `effect` 'read' | 'write', required: read changes nothing on the site; write changes something there
    - `input_schema` object, required: What a run's input takes, as JSON Schema. References are resolved: one left in a recursive schema points at its root $defs
    - `output_schema` object, required: What a succeeded run's result holds, as JSON Schema, in the same form
    - `login` object, nullable, required: What its sign-in takes; null when it needs none
      - `fields` string[], required: The login fields a run may carry for its sign-in
      - `two_factor_methods` string[], required: Second steps its recorded sign-in offered; empty when none was recorded
    - `mcp_name` string, required: Its tool name on its integration's MCP, such as get_claim_status
    - `can_change` boolean, required: Whether you can request a change to this tool: you can run it and build tools, and you aren't using an integration key
    - `egress` object: Its location: only on your Business account's private tools, where Pomerado offers it
      - `location` 'US' | 'GB' | 'FR' | 'DE' | 'SG', required: The country websites see its builds, changes and runs coming from, unless a run names another
  - `notice` ToolsNotice: Present only without credentials: the list holds only public read-only tools that need no login. Signing up (free) or signing in shows every tool.
    - `code` 'sign_in_to_see_all_tools', required
    - `message` string, required: Says the list holds only tools you can run without an account, that signing up (free) or signing in adds tools that write, saved logins and building tools, and how to do it
    - `docs_url` string, required: How to sign up or sign in

## Other responses

- `400`: invalid_request
- `401`: unauthorized, reauthentication_required
- `403`: forbidden
- `500`: internal_error
- `503`: temporarily_unavailable

---

[API](https://skmtc.dev/pomerado/apis/pomerado-api.md) · [All operations](https://skmtc.dev/pomerado/apis/pomerado-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pomerado/apis/pomerado-api/revisions/48dac2a3143e?raw)