add_api_example

Save a response example on an endpoint (for instance the 402 your handler returns for a declined card). Replaces the example with the same name, so it is safe to repeat.

Argument	Type	Description
body	any	Example response body (any JSON).
name*	string	e.g. Card declined.
path	string	Route path as written in the code, e.g. /v1/charges/:id or /v1/charges/{id}.
method	string	HTTP method of the route, e.g. POST. Use with path instead of endpoint_id.
status*	integer
headers	array
endpoint_id	string	Id of the endpoint. Alternative to method + path.
status_text	string
collection_id*	string	Id from list_api_collections.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "collection_id",
    "name",
    "status"
  ],
  "properties": {
    "body": {
      "description": "Example response body (any JSON)."
    },
    "name": {
      "type": "string",
      "description": "e.g. Card declined."
    },
    "path": {
      "type": "string",
      "description": "Route path as written in the code, e.g. /v1/charges/:id or /v1/charges/{id}."
    },
    "method": {
      "type": "string",
      "description": "HTTP method of the route, e.g. POST. Use with path instead of endpoint_id."
    },
    "status": {
      "type": "integer"
    },
    "headers": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "name",
          "value"
        ],
        "properties": {
          "name": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      }
    },
    "endpoint_id": {
      "type": "string",
      "description": "Id of the endpoint. Alternative to method + path."
    },
    "status_text": {
      "type": "string"
    },
    "collection_id": {
      "type": "string",
      "description": "Id from list_api_collections."
    }
  }
}

check_api_drift

Compare a collection's docs with the real traffic a tunnel captured (Pro/Team). Returns routes nobody documented, status codes with no example, response or request fields missing from every example (or with another type), undocumented query parameters, and documented fields that never appear. Each finding includes `request_id` of the newest request that shows it: pass it to save_captured_request to add it to the docs, or fix the docs with upsert_api_endpoint and add_api_example. Use it to find out what drifted after a code change.

read-only

Argument	Type	Description
limit	integer	How many recent requests to compare (default 200, max 500).
tunnel*	string	Subdomain of the tunnel whose traffic to compare.
collection_id*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "collection_id",
    "tunnel"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "description": "How many recent requests to compare (default 200, max 500)."
    },
    "tunnel": {
      "type": "string",
      "description": "Subdomain of the tunnel whose traffic to compare."
    },
    "collection_id": {
      "type": "string"
    }
  }
}

create_api_collection

Create an empty API collection. Prefer import_api_spec when there is an OpenAPI file, and upsert_api_endpoint to fill it from the code.

Argument	Type	Description
name*	string
description	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  }
}

delete_api_endpoint

Delete an endpoint and its examples. Use when the route no longer exists in the code. Cannot be undone.

destructive

Argument	Type	Description
path	string	Route path as written in the code, e.g. /v1/charges/:id or /v1/charges/{id}.
method	string	HTTP method of the route, e.g. POST. Use with path instead of endpoint_id.
endpoint_id	string	Id of the endpoint. Alternative to method + path.
collection_id*	string	Id from list_api_collections.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "collection_id"
  ],
  "properties": {
    "path": {
      "type": "string",
      "description": "Route path as written in the code, e.g. /v1/charges/:id or /v1/charges/{id}."
    },
    "method": {
      "type": "string",
      "description": "HTTP method of the route, e.g. POST. Use with path instead of endpoint_id."
    },
    "endpoint_id": {
      "type": "string",
      "description": "Id of the endpoint. Alternative to method + path."
    },
    "collection_id": {
      "type": "string",
      "description": "Id from list_api_collections."
    }
  }
}

export_api_collection

Export a collection as an OpenAPI 3.1 or Postman 2.1 document. Handy to read the whole API at once.

read-only

Argument	Type	Description
format	string
collection_id*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "collection_id"
  ],
  "properties": {
    "format": {
      "enum": [
        "openapi",
        "postman"
      ],
      "type": "string"
    },
    "collection_id": {
      "type": "string"
    }
  }
}

get_api_collection

Get one collection's folders, endpoints (id, method, path, name, version, example count) and environments (with their variables).

read-only

Argument	Type	Description
collection_id*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "collection_id"
  ],
  "properties": {
    "collection_id": {
      "type": "string"
    }
  }
}

get_api_endpoint

Get one endpoint in full: description, parameters, headers, request body, saved response examples and its current `version`. Identify it by endpoint_id or by method + path.

read-only

Argument	Type	Description
path	string	Route path as written in the code, e.g. /v1/charges/:id or /v1/charges/{id}.
method	string	HTTP method of the route, e.g. POST. Use with path instead of endpoint_id.
endpoint_id	string	Id of the endpoint. Alternative to method + path.
collection_id*	string	Id from list_api_collections.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "collection_id"
  ],
  "properties": {
    "path": {
      "type": "string",
      "description": "Route path as written in the code, e.g. /v1/charges/:id or /v1/charges/{id}."
    },
    "method": {
      "type": "string",
      "description": "HTTP method of the route, e.g. POST. Use with path instead of endpoint_id."
    },
    "endpoint_id": {
      "type": "string",
      "description": "Id of the endpoint. Alternative to method + path."
    },
    "collection_id": {
      "type": "string",
      "description": "Id from list_api_collections."
    }
  }
}

get_api_share_link

Get the shareable link of an endpoint (a read-only page with its docs, examples and latest run, secrets hidden), who can open it and who was invited. Use it to put the link in a PR, an issue or a message. Each endpoint has one link that never changes; `shared: false` means it has none yet (see share_api_endpoint).

read-only

Argument	Type	Description
path	string	Route path as written in the code, e.g. /v1/charges/:id or /v1/charges/{id}.
method	string	HTTP method of the route, e.g. POST. Use with path instead of endpoint_id.
endpoint_id	string	Id of the endpoint. Alternative to method + path.
collection_id*	string	Id from list_api_collections.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "collection_id"
  ],
  "properties": {
    "path": {
      "type": "string",
      "description": "Route path as written in the code, e.g. /v1/charges/:id or /v1/charges/{id}."
    },
    "method": {
      "type": "string",
      "description": "HTTP method of the route, e.g. POST. Use with path instead of endpoint_id."
    },
    "endpoint_id": {
      "type": "string",
      "description": "Id of the endpoint. Alternative to method + path."
    },
    "collection_id": {
      "type": "string",
      "description": "Id from list_api_collections."
    }
  }
}

get_request

Get the full request and response (headers + body) of one captured webhook by id.

read-only

Argument	Type	Description
id*	string
subdomain*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "subdomain",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "subdomain": {
      "type": "string"
    }
  }
}

import_api_spec

Import an OpenAPI 3.x document (as JSON), a Postman v2.x collection (JSON) or a curl command into a new collection, or into `collection_id`. All or nothing, and plan limits are checked first. Credentials are never imported (they become variables). Convert YAML to JSON before sending.

Argument	Type	Description
name	string	Name for the new collection.
format*	string
content*	any	The document (object or JSON string), or the curl command.
collection_id	string	Add to this collection instead of creating one.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "format",
    "content"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Name for the new collection."
    },
    "format": {
      "enum": [
        "openapi",
        "postman",
        "har",
        "curl"
      ],
      "type": "string"
    },
    "content": {
      "description": "The document (object or JSON string), or the curl command."
    },
    "collection_id": {
      "type": "string",
      "description": "Add to this collection instead of creating one."
    }
  }
}

list_api_collections

List the workspace's API collections (saved endpoints with examples and environments). Start here to find a collection_id.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {}
}

list_api_monitors

See which endpoints of a collection are checked on a schedule (Pro/Team monitors) and how they are doing: state (healthy, failing, blip, paused, waiting), the last check with its status, latency and error, and since when it has been failing. Use it to find out what is broken in staging or production, then read the endpoint and its code. Read-only: people decide what to monitor.

read-only

Argument	Type	Description
collection_id*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "collection_id"
  ],
  "properties": {
    "collection_id": {
      "type": "string"
    }
  }
}

list_api_proposals

See what happened to the changes you proposed. Some workspaces review AI changes: your write tools then answer `pending_review` and change nothing until a teammate approves. This lists the latest proposals with their status (pending, approved, rejected with the reviewer's reason, or failed with why) so you can tell whether a change went through.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {}
}

list_api_runs

Recent runs of an endpoint (newest first, default 5): who/what was sent and what came back. Use to see what happened the last time it was run.

read-only

Argument	Type	Description
path	string	Route path as written in the code, e.g. /v1/charges/:id or /v1/charges/{id}.
limit	integer	1 to 20.
method	string	HTTP method of the route, e.g. POST. Use with path instead of endpoint_id.
endpoint_id	string	Id of the endpoint. Alternative to method + path.
collection_id*	string	Id from list_api_collections.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "collection_id"
  ],
  "properties": {
    "path": {
      "type": "string",
      "description": "Route path as written in the code, e.g. /v1/charges/:id or /v1/charges/{id}."
    },
    "limit": {
      "type": "integer",
      "description": "1 to 20."
    },
    "method": {
      "type": "string",
      "description": "HTTP method of the route, e.g. POST. Use with path instead of endpoint_id."
    },
    "endpoint_id": {
      "type": "string",
      "description": "Id of the endpoint. Alternative to method + path."
    },
    "collection_id": {
      "type": "string",
      "description": "Id from list_api_collections."
    }
  }
}

list_requests

List recent webhooks/requests captured for a tunnel. Returns id, method, path, status and bodies.

read-only

Argument	Type	Description
subdomain*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "subdomain"
  ],
  "properties": {
    "subdomain": {
      "type": "string"
    }
  }
}

list_tunnels

List the user's Pipehero tunnels and whether each is currently online.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {}
}

replay_request

Replay a captured webhook to the user's localhost (the tunnel CLI must be running).

destructive

Argument	Type	Description
id*	string
subdomain*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "subdomain",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "subdomain": {
      "type": "string"
    }
  }
}

run_api_endpoint

Send an endpoint against an environment and return the real response (status, headers, body up to 20 KB). A `local` environment goes through the user's tunnel to their localhost (the CLI must be running); staging/prod are sent from Pipehero's cloud (Pro/Team) to public addresses only. Sending to a `prod` environment with a write method needs confirm_write_to_prod: true, which you should only pass after the user agrees. Use it to check that the code you wrote behaves as documented.

destructive

Argument	Type	Description
path	string	Route path as written in the code, e.g. /v1/charges/:id or /v1/charges/{id}.
method	string	HTTP method of the route, e.g. POST. Use with path instead of endpoint_id.
variables	object	Values for {{variables}} the environment doesn't define, e.g. {"id": "ch_123"}.
endpoint_id	string	Id of the endpoint. Alternative to method + path.
environment*	string	Environment name or id, e.g. local.
collection_id*	string	Id from list_api_collections.
confirm_write_to_prod	boolean

save_captured_request

Document a real request captured by a tunnel (get its id from list_requests). If an endpoint already covers the route, the response is added to it as an example; otherwise an endpoint is created from the request. Credentials, cookies and signatures are replaced by {{variables}} and only JSON bodies are kept. A response already saved as an example is not duplicated. Use it to document webhooks and calls you have only seen in traffic.

Argument	Type	Description
path	string
folder	string	Folder for a newly created endpoint, created by name if missing.
method	string	With path: the endpoint that should receive the example.
tunnel*	string	Subdomain of the tunnel that captured the request.
request_id*	string	Id of the captured request, from list_requests.
endpoint_id	string	Add the example to this endpoint instead of matching by route. Alternative to method + path.
collection_id*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "collection_id",
    "tunnel",
    "request_id"
  ],
  "properties": {
    "path": {
      "type": "string"
    },
    "folder": {
      "type": "string",
      "description": "Folder for a newly created endpoint, created by name if missing."
    },
    "method": {
      "type": "string",
      "description": "With path: the endpoint that should receive the example."
    },
    "tunnel": {
      "type": "string",
      "description": "Subdomain of the tunnel that captured the request."
    },
    "request_id": {
      "type": "string",
      "description": "Id of the captured request, from list_requests."
    },
    "endpoint_id": {
      "type": "string",
      "description": "Add the example to this endpoint instead of matching by route. Alternative to method + path."
    },
    "collection_id": {
      "type": "string"
    }
  }
}

send_test_webhook

Send a generated test webhook to the user's localhost (the tunnel CLI must be running). Provide a `provider` (stripe, github, shopify, clerk, slack, resend, paddle, polar, lemonsqueezy) and optional `event` for a realistic sample payload, or pass a custom JSON `body`. Pro plan required.

destructive

Argument	Type	Description
body	string	Custom JSON body (overrides the template)
event	string
provider*	string
subdomain*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "subdomain",
    "provider"
  ],
  "properties": {
    "body": {
      "type": "string",
      "description": "Custom JSON body (overrides the template)"
    },
    "event": {
      "type": "string"
    },
    "provider": {
      "type": "string"
    },
    "subdomain": {
      "type": "string"
    }
  }
}

set_long_requests

Opt a tunnel into a 120-second ingress timeout instead of the 30-second default — for tool calls that legitimately run long, e.g. an MCP server exposed through the tunnel. Persists on the tunnel; pass enabled: false to revert to the 30-second default.

Argument	Type	Description
enabled*	boolean
subdomain*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "subdomain",
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "subdomain": {
      "type": "string"
    }
  }
}

set_ws_passthrough

Opt a tunnel into WebSocket passthrough, so an application-level WebSocket connection (e.g. a mobile/web app's own realtime feature) can be relayed to your localhost. Pro/Team plan required to enable; pass enabled: false to disable on any plan.

Argument	Type	Description
enabled*	boolean
subdomain*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "subdomain",
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "subdomain": {
      "type": "string"
    }
  }
}

share_api_collection

Share a whole collection: every endpoint in it (including ones added later), with its examples and latest run, read-only and with secrets hidden. Environments are never shown and it can't be exported. Returns the collection's link, which never changes. With no other arguments it stays restricted to the workspace; set `link_access` or `invite` people only when the user asks to share it outside the team. get_api_collection returns the link as `share` once it exists.

Argument	Type	Description
invite	array	People to invite by email (at most 10). Each gets an email.
link_access	string	Who can open it with just the link. Omit to keep the current setting (restricted for a new share).
collection_id*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "collection_id"
  ],
  "properties": {
    "invite": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "email"
        ],
        "properties": {
          "role": {
            "enum": [
              "viewer",
              "commenter"
            ],
            "type": "string"
          },
          "email": {
            "type": "string"
          }
        }
      },
      "description": "People to invite by email (at most 10). Each gets an email."
    },
    "link_access": {
      "enum": [
        "restricted",
        "viewer",
        "commenter"
      ],
      "type": "string",
      "description": "Who can open it with just the link. Omit to keep the current setting (restricted for a new share)."
    },
    "collection_id": {
      "type": "string"
    }
  }
}

share_api_endpoint

Create an endpoint's shareable link and return it. With no other arguments the link stays restricted: workspace members can open it (they sign in), which is enough for a PR or an internal message. Only when the user asks to share it outside the workspace: set `link_access` to `viewer` (anyone with the link can read) or `commenter` (Team plan; commenting asks for sign-in), or `invite` people by email (they get an email and sign in with that address). `restricted` turns the public link off; the URL stays the same. The page is read-only and always hides credentials and secrets.

Argument	Type	Description
path	string	Route path as written in the code, e.g. /v1/charges/:id or /v1/charges/{id}.
invite	array	People to invite by email (at most 10). Each gets an email.
method	string	HTTP method of the route, e.g. POST. Use with path instead of endpoint_id.
endpoint_id	string	Id of the endpoint. Alternative to method + path.
link_access	string	Who can open it with just the link. Omit to keep the current setting (restricted for a new share).
collection_id*	string	Id from list_api_collections.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "collection_id"
  ],
  "properties": {
    "path": {
      "type": "string",
      "description": "Route path as written in the code, e.g. /v1/charges/:id or /v1/charges/{id}."
    },
    "invite": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "email"
        ],
        "properties": {
          "role": {
            "enum": [
              "viewer",
              "commenter"
            ],
            "type": "string"
          },
          "email": {
            "type": "string"
          }
        }
      },
      "description": "People to invite by email (at most 10). Each gets an email."
    },
    "method": {
      "type": "string",
      "description": "HTTP method of the route, e.g. POST. Use with path instead of endpoint_id."
    },
    "endpoint_id": {
      "type": "string",
      "description": "Id of the endpoint. Alternative to method + path."
    },
    "link_access": {
      "enum": [
        "restricted",
        "viewer",
        "commenter"
      ],
      "type": "string",
      "description": "Who can open it with just the link. Omit to keep the current setting (restricted for a new share)."
    },
    "collection_id": {
      "type": "string",
      "description": "Id from list_api_collections."
    }
  }
}

upsert_api_endpoint

Document an endpoint: creates it, or updates the existing one for the same method + path. Use it whenever you add or change a route in the code, so the docs stay true. Only the fields you send change. `path` may use :id, {id} or {{id}} for variables. `folder` is created by name if missing. Send `version` (from get_api_endpoint) to avoid overwriting a teammate's edit; a stale version is rejected.

Argument	Type	Description
body	any	Example request body (any JSON). null clears it.
kind	string	`event` for a webhook your app sends.
name	string	Short title, e.g. Create a charge. Defaults to METHOD /path.
path*	string
folder	string	Folder name, e.g. Charges.
method*	string
params	array	Documented fields.
headers	array
version	integer
description

Pipehero

Try it

add_api_example

Pipehero

Try it

add_api_example

Tools (25)