---
title: "Get a tool"
method: GET
path: "/v1/tools/{id}"
tags: ["tools"]
---

# Get a tool

`GET /v1/tools/{id}`

## Request

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

Get one tool: its input and output schemas, effect, sign-in needs and integration.

- A disabled tool, or another account's private tool, is not found. An integration key reaches only its own integration's tools.
- Without credentials, where allowed, it reads only public tools, and a tool that writes or needs a login answers sign_in_required.

## Path parameters

- `id` string, required

## Response `200`

The tool

- Tool
  - `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

## Other responses

- `400`: invalid_request
- `401`: sign_in_required, unauthorized, reauthentication_required
- `403`: forbidden
- `404`: not_found
- `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/c07cea59691c?raw)