# Custom API tools

> Every Custom API tool in the developer API, with its arguments and an example call.

**Needs:** A Custom API connection (Pro and Agency). Each imported OpenAPI operation also becomes its own tool, named after the connection. 2 tools.

These tools appear in `GET /v1/tools` only when the API key's MCP server includes a connection of this kind. Call each one with `POST /v1/tools/\<name>`, sending its arguments as a JSON object. See [Calling tools](https://docs.plugsight.app/developers/calling-tools.md) for the request and response format.

Each operation imported from the connection's OpenAPI spec is also its own tool, named after the connection and the operation (for example `acme_crm_list_invoices`), for connections with up to 50 operations. Those tools differ for every connection, so they aren't listed here: `GET /v1/tools` shows the ones your API key reaches, and `custom_api_operations` lists every imported operation, with its parameters.

| Tool | What it does | Kind |
| --- | --- | --- |
| [`custom_api_operations`](#custom_api_operations) | List a Custom API's operations | Read |
| [`custom_api_request`](#custom_api_request) | Call a Custom API | Change |

Change tools in this group: `custom_api_request`. Check each tool's notes below for what it needs before it runs.

The example requests fill in only the required arguments, with placeholder values.

## custom_api_operations

**List a Custom API's operations** · Read

Lists the operations imported from a Custom API connection's OpenAPI spec: each one's operation_id, method, path, summary, parameters and body schema, and its own tool name when it has one. Call one with its tool, or with custom_api_request and operation_id. Use search to narrow a long list.

| Argument | Type | Required | What it is |
| --- | --- | --- | --- |
| `account` | string | No | Custom API connection id from list_accounts (optional when there's only one) |
| `search` | string | No | Only operations whose id, path or summary contain these words |
| `limit` | integer | No | Most operations to return (default 100) |

Example request:

```bash
curl -X POST https://app.plugsight.app/v1/tools/custom_api_operations \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

## custom_api_request

**Call a Custom API** · Change

Sends one HTTP request to a Custom API connection, signed with its saved credentials. Give a method and a path under the connection's base URL (never a full address), or an imported operation's operation_id with its params. GET and HEAD only read. Changes also need changes allowed for the connection and the MCP server. Any HTTP status comes back as data, with the body (JSON parsed; long bodies are cut at about 100,000 characters and marked truncated).

> [!IMPORTANT]
> `GET` and `HEAD` requests only read. `POST`, `PUT`, `PATCH` and `DELETE` make a change, so they must include `"confirm": true`, and changes must be allowed. See [Making changes](https://docs.plugsight.app/developers/calling-tools.md#making-changes).

| Argument | Type | Required | What it is |
| --- | --- | --- | --- |
| `account` | string | No | Custom API connection id from list_accounts (optional when there's only one) |
| `method` | string | No | HTTP method (default GET) One of: `GET`, `HEAD`, `POST`, `PUT`, `PATCH`, `DELETE`. |
| `path` | string | No | Path under the base URL, like /users/42 |
| `query` | object | No | Query string parameters, by name |
| `body` | any | No | Request body: JSON (sent as application/json) or a string (sent as text) |
| `headers` | object | No | Extra request headers. Not Authorization, cookies or the connection's own headers |
| `operation_id` | string | No | An imported operation's id from custom_api_operations, instead of method and path |
| `params` | object | No | With operation_id: its path, query and header parameters, by name (or by location and name, like "query:id", when two share a name) |
| `confirm` | boolean | No | Must be true for POST, PUT, PATCH and DELETE: the user approved this exact request |

Example request:

```bash
curl -X POST https://app.plugsight.app/v1/tools/custom_api_request \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"method": "GET", "path": "/users", "query": {"limit": 10}}'
```

## Related articles

- [Calling tools](https://docs.plugsight.app/developers/calling-tools.md)
- [Errors](https://docs.plugsight.app/developers/errors.md)
- [Authentication](https://docs.plugsight.app/developers/authentication.md)

---

Web version: https://docs.plugsight.app/developers/custom-api-tools
