> For the complete documentation index, see [llms.txt](https://docs.nerovasystems.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nerovasystems.com/mcp-server/tools.md).

# Tool reference

Generated reference for every MCP tool: name, method, path, required scopes, and access class, derived mechanically from the tenant-v1 contract.

Every MCP tool maps one-to-one onto an operation of the published `tenant-v1` API and is derived mechanically from the contract, so this reference can never drift from the API surface. `tools/list` returns only the tools whose required scopes your connection holds; everything else stays invisible. Calls execute against the same API as any other consumer. See the [API reference](https://docs.nerovasystems.com/documentation/api/reference) for full request and response shapes, and [Authentication](/mcp-server/authentication.md) for how access is granted.

Access legend: **Read-only** tools never change state. **Write** tools create or update records and receive an automatic idempotency key per invocation. **Destructive** tools deactivate, suspend, cancel, delete, or revoke. MCP clients should ask for confirmation before calling them.

72 tools, grouped by permission area.

## General

| Tool          | Operation             | Access    | Required scopes | Summary             |
| ------------- | --------------------- | --------- | --------------- | ------------------- |
| `get_context` | `GET /api/v1/context` | Read-only | None            | Get API key context |
| `get_status`  | `GET /api/v1/status`  | Read-only | None            | Get service status  |

## capability

| Tool                                | Operation                                                   | Access    | Required scopes                                                     | Summary                     |
| ----------------------------------- | ----------------------------------------------------------- | --------- | ------------------------------------------------------------------- | --------------------------- |
| `get_tenants_activation_manifest`   | `GET /api/v1/tenants/{tenantId}/activation/manifest`        | Read-only | `capability:read`, `employee:read`, `mandate:read`, `merchant:read` | Get the activation manifest |
| `get_tenants_capabilities`          | `GET /api/v1/tenants/{tenantId}/capabilities`               | Read-only | `capability:read`                                                   | List capabilities           |
| `get_tenants_channels`              | `GET /api/v1/tenants/{tenantId}/channels`                   | Read-only | `capability:read`                                                   | List channels               |
| `get_tenants_connections`           | `GET /api/v1/tenants/{tenantId}/connections/{connectionId}` | Read-only | `capability:read`                                                   | Get a connection            |
| `get_tenants_connections_all`       | `GET /api/v1/tenants/{tenantId}/connections`                | Read-only | `capability:read`                                                   | List connections            |
| `post_tenants_activation_activate`  | `POST /api/v1/tenants/{tenantId}/activation/activate`       | Write     | `capability:read`, `employee:manage`, `mandate:read`                | Activate the employee       |
| `post_tenants_activation_preview`   | `POST /api/v1/tenants/{tenantId}/activation/preview`        | Write     | `capability:read`, `mandate:read`, `merchant:read`                  | Preview activation          |
| `post_tenants_activation_reconcile` | `POST /api/v1/tenants/{tenantId}/activation/reconcile`      | Write     | `capability:read`, `employee:manage`                                | Reconcile the employee      |

## channel

| Tool                                                   | Operation                                                                             | Access      | Required scopes  | Summary                       |
| ------------------------------------------------------ | ------------------------------------------------------------------------------------- | ----------- | ---------------- | ----------------------------- |
| `delete_tenants_connections`                           | `DELETE /api/v1/tenants/{tenantId}/connections/{connectionId}`                        | Destructive | `channel:manage` | Revoke a connection           |
| `post_tenants_activation_connection_sessions`          | `POST /api/v1/tenants/{tenantId}/activation/connection-sessions`                      | Write       | `channel:manage` | Create a connection session   |
| `post_tenants_activation_connection_sessions_complete` | `POST /api/v1/tenants/{tenantId}/activation/connection-sessions/{sessionId}/complete` | Write       | `channel:manage` | Complete a connection session |
| `post_tenants_connections`                             | `POST /api/v1/tenants/{tenantId}/connections`                                         | Write       | `channel:manage` | Create a connection           |
| `post_tenants_connections_test`                        | `POST /api/v1/tenants/{tenantId}/connections/{connectionId}/test`                     | Write       | `channel:manage` | Test a connection             |
| `post_tenants_connections_verify`                      | `POST /api/v1/tenants/{tenantId}/connections/{connectionId}/verify`                   | Write       | `channel:manage` | Verify a connection           |
| `put_tenants_connections_base_url`                     | `PUT /api/v1/tenants/{tenantId}/connections/{connectionId}/base-url`                  | Write       | `channel:manage` | Rotate the base URL           |
| `put_tenants_connections_credential`                   | `PUT /api/v1/tenants/{tenantId}/connections/{connectionId}/credential`                | Write       | `channel:manage` | Replace the credential        |

## conversation

| Tool                                  | Operation                                                                 | Access    | Required scopes      | Summary            |
| ------------------------------------- | ------------------------------------------------------------------------- | --------- | -------------------- | ------------------ |
| `get_tenants_conversations`           | `GET /api/v1/tenants/{tenantId}/conversations`                            | Read-only | `conversation:read`  | List conversations |
| `get_tenants_conversations2`          | `GET /api/v1/tenants/{tenantId}/conversations/{conversationId}`           | Read-only | `conversation:read`  | Get a conversation |
| `post_tenants_conversations_messages` | `POST /api/v1/tenants/{tenantId}/conversations/{conversationId}/messages` | Write     | `conversation:write` | Send a message     |

## employee

| Tool                                 | Operation                                               | Access      | Required scopes                    | Summary                    |
| ------------------------------------ | ------------------------------------------------------- | ----------- | ---------------------------------- | -------------------------- |
| `get_tenants_employee`               | `GET /api/v1/tenants/{tenantId}/employee`               | Read-only   | `employee:read`                    | Get the employee           |
| `post_tenants_activation_deactivate` | `POST /api/v1/tenants/{tenantId}/activation/deactivate` | Destructive | `employee:manage`                  | Deactivate the employee    |
| `post_tenants_activation_pause`      | `POST /api/v1/tenants/{tenantId}/activation/pause`      | Write       | `employee:manage`                  | Pause the employee         |
| `post_tenants_activation_suspend`    | `POST /api/v1/tenants/{tenantId}/activation/suspend`    | Destructive | `employee:manage`                  | Suspend the employee       |
| `put_tenants_activation_consents`    | `PUT /api/v1/tenants/{tenantId}/activation/consents`    | Write       | `employee:manage`                  | Capture consents           |
| `put_tenants_activation_mandate`     | `PUT /api/v1/tenants/{tenantId}/activation/mandate`     | Write       | `employee:manage`, `mandate:write` | Set the activation mandate |

## incident

| Tool                    | Operation                                  | Access    | Required scopes | Summary        |
| ----------------------- | ------------------------------------------ | --------- | --------------- | -------------- |
| `get_tenants_incidents` | `GET /api/v1/tenants/{tenantId}/incidents` | Read-only | `incident:read` | List incidents |

## mandate

| Tool                  | Operation                                | Access    | Required scopes | Summary            |
| --------------------- | ---------------------------------------- | --------- | --------------- | ------------------ |
| `get_tenants_mandate` | `GET /api/v1/tenants/{tenantId}/mandate` | Read-only | `mandate:read`  | Get the mandate    |
| `put_tenants_mandate` | `PUT /api/v1/tenants/{tenantId}/mandate` | Write     | `mandate:write` | Update the mandate |

## memory

| Tool                              | Operation                                                       | Access      | Required scopes | Summary               |
| --------------------------------- | --------------------------------------------------------------- | ----------- | --------------- | --------------------- |
| `delete_tenants_memory`           | `DELETE /api/v1/tenants/{tenantId}/memory/{memoryId}`           | Destructive | `memory:write`  | Delete a memory fact  |
| `get_tenants_memory`              | `GET /api/v1/tenants/{tenantId}/memory`                         | Read-only   | `memory:read`   | List memory facts     |
| `post_tenants_memory`             | `POST /api/v1/tenants/{tenantId}/memory`                        | Write       | `memory:write`  | Create a memory fact  |
| `post_tenants_memory_corrections` | `POST /api/v1/tenants/{tenantId}/memory/{memoryId}/corrections` | Write       | `memory:write`  | Correct a memory fact |

## merchant

| Tool                                             | Operation                                                           | Access    | Required scopes      | Summary                     |
| ------------------------------------------------ | ------------------------------------------------------------------- | --------- | -------------------- | --------------------------- |
| `get_tenants`                                    | `GET /api/v1/tenants/{tenantId}`                                    | Read-only | `merchant:read`      | Get a tenant                |
| `get_tenants_activity`                           | `GET /api/v1/tenants/{tenantId}/activity`                           | Read-only | `merchant:read`      | Get tenant activity         |
| `get_tenants_all`                                | `GET /api/v1/tenants`                                               | Read-only | `merchant:read`      | List tenants                |
| `patch_tenants`                                  | `PATCH /api/v1/tenants/{tenantId}`                                  | Write     | `merchant:provision` | Update a tenant             |
| `post_tenants`                                   | `POST /api/v1/tenants`                                              | Write     | `merchant:provision` | Create a tenant             |
| `post_tenants_activation_identity_confirmations` | `POST /api/v1/tenants/{tenantId}/activation/identity-confirmations` | Write     | `merchant:provision` | Confirm identity            |
| `post_tenants_lifecycle`                         | `POST /api/v1/tenants/{tenantId}/lifecycle/{state}`                 | Write     | `merchant:provision` | Set tenant lifecycle        |
| `put_tenants_activation_provisioning`            | `PUT /api/v1/tenants/{tenantId}/activation/provisioning`            | Write     | `merchant:provision` | Set provisioning references |
| `put_tenants_usage_limits`                       | `PUT /api/v1/tenants/{tenantId}/usage/limits`                       | Write     | `merchant:provision` | Set usage limits            |

## notification

| Tool                                 | Operation                                                                    | Access    | Required scopes     | Summary                      |
| ------------------------------------ | ---------------------------------------------------------------------------- | --------- | ------------------- | ---------------------------- |
| `get_tenants_notifications`          | `GET /api/v1/tenants/{tenantId}/notifications`                               | Read-only | `notification:send` | List notifications           |
| `get_tenants_notifications2`         | `GET /api/v1/tenants/{tenantId}/notifications/{notificationId}`              | Read-only | `notification:send` | Get a notification           |
| `get_tenants_notifications_catalog`  | `GET /api/v1/tenants/{tenantId}/notifications/catalog`                       | Read-only | `notification:send` | Get the notification catalog |
| `get_tenants_notifications_consents` | `GET /api/v1/tenants/{tenantId}/notifications/consents/{recipientReference}` | Read-only | `notification:send` | Get notification consent     |
| `get_tenants_notifications_settings` | `GET /api/v1/tenants/{tenantId}/notifications/settings`                      | Read-only | `notification:send` | Get notification settings    |
| `post_tenants_notifications`         | `POST /api/v1/tenants/{tenantId}/notifications`                              | Write     | `notification:send` |                              |
| `put_tenants_notifications_consents` | `PUT /api/v1/tenants/{tenantId}/notifications/consents`                      | Write     | `notification:send` | Record notification consent  |
| `put_tenants_notifications_settings` | `PUT /api/v1/tenants/{tenantId}/notifications/settings`                      | Write     | `notification:send` | Update notification settings |

## performance

| Tool                      | Operation                                    | Access    | Required scopes    | Summary         |
| ------------------------- | -------------------------------------------- | --------- | ------------------ | --------------- |
| `get_tenants_performance` | `GET /api/v1/tenants/{tenantId}/performance` | Read-only | `performance:read` | Get performance |

## receipt

| Tool                              | Operation                                                        | Access    | Required scopes             | Summary                   |
| --------------------------------- | ---------------------------------------------------------------- | --------- | --------------------------- | ------------------------- |
| `get_tenants_activation_receipts` | `GET /api/v1/tenants/{tenantId}/activation/receipts/{receiptId}` | Read-only | `receipt:read`              | Get an activation receipt |
| `get_tenants_work`                | `GET /api/v1/tenants/{tenantId}/work`                            | Read-only | `receipt:read`, `work:read` | List work                 |
| `get_tenants_work2`               | `GET /api/v1/tenants/{tenantId}/work/{workId}`                   | Read-only | `receipt:read`, `work:read` | Get a work item           |

## usage

| Tool                        | Operation                                      | Access    | Required scopes | Summary           |
| --------------------------- | ---------------------------------------------- | --------- | --------------- | ----------------- |
| `get_tenants_usage`         | `GET /api/v1/tenants/{tenantId}/usage`         | Read-only | `usage:read`    | Get usage         |
| `get_tenants_usage_limits`  | `GET /api/v1/tenants/{tenantId}/usage/limits`  | Read-only | `usage:read`    | Get usage limits  |
| `get_tenants_usage_summary` | `GET /api/v1/tenants/{tenantId}/usage/summary` | Read-only | `usage:read`    | Get usage summary |

## webhook

| Tool                                       | Operation                                                                  | Access      | Required scopes  | Summary                   |
| ------------------------------------------ | -------------------------------------------------------------------------- | ----------- | ---------------- | ------------------------- |
| `delete_tenants_webhooks`                  | `DELETE /api/v1/tenants/{tenantId}/webhooks/{webhookId}`                   | Destructive | `webhook:manage` | Delete a webhook endpoint |
| `get_tenants_webhooks`                     | `GET /api/v1/tenants/{tenantId}/webhooks/{webhookId}`                      | Read-only   | `webhook:manage` | Get a webhook endpoint    |
| `get_tenants_webhooks_all`                 | `GET /api/v1/tenants/{tenantId}/webhooks`                                  | Read-only   | `webhook:manage` | List webhook endpoints    |
| `get_tenants_webhooks_catalog`             | `GET /api/v1/tenants/{tenantId}/webhooks/catalog`                          | Read-only   | `webhook:manage` | Get the event catalog     |
| `get_tenants_webhooks_deliveries`          | `GET /api/v1/tenants/{tenantId}/webhooks/deliveries`                       | Read-only   | `webhook:manage` | List deliveries           |
| `get_tenants_webhooks_deliveries2`         | `GET /api/v1/tenants/{tenantId}/webhooks/deliveries/{deliveryId}`          | Read-only   | `webhook:manage` | Get a delivery            |
| `get_tenants_webhooks_stats`               | `GET /api/v1/tenants/{tenantId}/webhooks/stats`                            | Read-only   | `webhook:manage` | Get delivery stats        |
| `post_tenants_webhooks`                    | `POST /api/v1/tenants/{tenantId}/webhooks`                                 | Write       | `webhook:manage` | Create a webhook endpoint |
| `post_tenants_webhooks_deliveries_redrive` | `POST /api/v1/tenants/{tenantId}/webhooks/deliveries/{deliveryId}/redrive` | Write       | `webhook:manage` | Redrive a delivery        |
| `post_tenants_webhooks_pause`              | `POST /api/v1/tenants/{tenantId}/webhooks/{webhookId}/pause`               | Write       | `webhook:manage` | Pause a webhook endpoint  |
| `post_tenants_webhooks_resume`             | `POST /api/v1/tenants/{tenantId}/webhooks/{webhookId}/resume`              | Write       | `webhook:manage` | Resume a webhook endpoint |
| `post_tenants_webhooks_rotate_secret`      | `POST /api/v1/tenants/{tenantId}/webhooks/{webhookId}/rotate-secret`       | Write       | `webhook:manage` | Rotate the signing secret |
| `post_tenants_webhooks_test`               | `POST /api/v1/tenants/{tenantId}/webhooks/{webhookId}/test`                | Write       | `webhook:manage` | Send a test event         |
| `put_tenants_webhooks`                     | `PUT /api/v1/tenants/{tenantId}/webhooks/{webhookId}`                      | Write       | `webhook:manage` | Update a webhook endpoint |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.nerovasystems.com/mcp-server/tools.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.