Server definition
- Hash
- sha256:01f2f704112f2cf89c00daafdb4007bdc8a50c377928b419781334af673055fd
- What it is
- What a remote MCP server returned when asked what it offers: 67 tools
The blob, as servednamed by its sha256
{
"instructions": null,
"tools": [
{
"description": "Single-call workspace snapshot: organization context, credential identity, send-capability flags (canSendEmail / canSendSms), inventory counts (agents, domains, phones), active blockers (each carrying the canonical MCP tool that resolves it), and the running MCP server's deploy identity (commitSha, revision, buildId, startedAt). Strict superset of the legacy whoami + workspace_health pair. Use before any non-trivial workflow to answer 'who am I, can I do X right now, and which deploy is serving me?' in one round-trip — no real send needed to find out.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "account_overview",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Create a new agent with optional metadata, and optionally attach an initial address. Use this when provisioning a new sending identity or automation actor. To add more addresses later, use agent_update. Pass idempotencyKey to make retries safe — same key + same body returns the original response, same key + different body returns IDEMPOTENCY_BODY_MISMATCH 409.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"address": {
"additionalProperties": false,
"description": "Optional initial postal address to attach to the agent on creation. To add more addresses later, use agent_update.",
"properties": {
"city": {
"description": "City name.",
"type": "string"
},
"country": {
"description": "ISO country code (e.g. US, GB).",
"type": "string"
},
"label": {
"description": "Optional human-readable label.",
"type": "string"
},
"postalCode": {
"description": "Postal or ZIP code.",
"type": "string"
},
"state": {
"description": "State or province code.",
"type": "string"
},
"street1": {
"description": "Primary street address line.",
"type": "string"
},
"street2": {
"description": "Secondary street address line (apt, suite, etc.).",
"type": "string"
},
"type": {
"description": "Address type: BILLING, SHIPPING, MAILING, or REGISTERED.",
"enum": [
"BILLING",
"SHIPPING",
"MAILING",
"REGISTERED"
],
"type": "string"
}
},
"required": [
"type",
"street1",
"city",
"state",
"postalCode",
"country"
],
"type": "object"
},
"email": {
"description": "Optional email address to provision for this agent",
"format": "email",
"type": "string"
},
"idempotencyKey": {
"description": "Optional Idempotency-Key. Send the SAME key on retries of the SAME create payload to guarantee exactly-once provisioning even if the network drops mid-flight. Reuse with a different body returns IDEMPOTENCY_BODY_MISMATCH 409. Keys are scoped per-credential, ASCII-printable 1-255 chars (Stripe convention). Server caches the response for 24h. Note: the idempotency guarantee covers the agent record only — if a subsequent address attachment fails, the agent will still exist.",
"maxLength": 255,
"minLength": 1,
"pattern": "^[\\x20-\\x7E]+$",
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Optional agent metadata as key-value string pairs",
"type": "object"
},
"name": {
"description": "Agent display name",
"type": "string"
},
"provisionPhone": {
"description": "Whether to auto-provision a phone number for this agent",
"type": "boolean"
},
"slug": {
"description": "URL-friendly unique identifier (lowercase alphanumeric + hyphens, 2-64 chars). Auto-derived from name if omitted.",
"maxLength": 64,
"minLength": 2,
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"name": "agent_create",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Delete an agent by ID. Use this to remove deprecated or compromised agents that should no longer send messages. Cascades to attached addresses, email identities, and phone identities.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "Agent ID",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "agent_delete",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"deleted": {
"type": "boolean"
},
"id": {
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Fetch full detail for a single agent by ID: settings, metadata, status, and the full addresses[] / emailIdentities[] / phoneIdentities[] lists. Use agent_list to browse multiple agents.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "Agent ID. Returns full agent detail including addresses, emailIdentities, and phoneIdentities.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "agent_get",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "List agents in the current account context with cursor pagination. Returns a lightweight per-agent record (addresses are NOT included to avoid N+1 round-trips). Use agent_get for full single-agent detail.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "Pagination cursor from a previous list response.",
"type": "string"
},
"limit": {
"description": "Maximum number of agents to return.",
"exclusiveMinimum": 0,
"type": "integer"
}
},
"type": "object"
},
"name": "agent_list",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"count": {
"type": "number"
},
"cursor": {
"type": [
"string",
"null"
]
},
"has_more": {
"type": "boolean"
},
"items": {
"items": {},
"type": "array"
},
"next_offset": {
"type": "number"
},
"total": {
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Update an agent's name or metadata, and/or add/update/delete an address. Use addAddress to attach a new address, updateAddress to change fields on an existing one (by addressId), deleteAddressId to remove one. Multiple field-level changes can be combined in a single call.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"addAddress": {
"additionalProperties": false,
"description": "Attach a new postal address to this agent.",
"properties": {
"city": {
"description": "City name.",
"type": "string"
},
"country": {
"description": "ISO country code (e.g. US, GB).",
"type": "string"
},
"label": {
"description": "Optional human-readable label.",
"type": "string"
},
"postalCode": {
"description": "Postal or ZIP code.",
"type": "string"
},
"state": {
"description": "State or province code.",
"type": "string"
},
"street1": {
"description": "Primary street address line.",
"type": "string"
},
"street2": {
"description": "Secondary street address line (apt, suite, etc.).",
"type": "string"
},
"type": {
"description": "Address type: BILLING, SHIPPING, MAILING, or REGISTERED.",
"enum": [
"BILLING",
"SHIPPING",
"MAILING",
"REGISTERED"
],
"type": "string"
}
},
"required": [
"type",
"street1",
"city",
"state",
"postalCode",
"country"
],
"type": "object"
},
"deleteAddressId": {
"description": "ID of an address to remove from this agent.",
"type": "string"
},
"id": {
"description": "Agent ID",
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Updated metadata as key-value string pairs",
"type": "object"
},
"name": {
"description": "Updated agent display name",
"type": "string"
},
"updateAddress": {
"additionalProperties": false,
"description": "Update fields on an existing address. Pass addressId + the fields to change.",
"properties": {
"addressId": {
"description": "ID of the address to update.",
"type": "string"
},
"city": {
"description": "Updated city.",
"type": "string"
},
"country": {
"description": "Updated country code.",
"type": "string"
},
"label": {
"description": "Updated label.",
"type": "string"
},
"postalCode": {
"description": "Updated postal code.",
"type": "string"
},
"state": {
"description": "Updated state or province.",
"type": "string"
},
"street1": {
"description": "Updated primary street address.",
"type": "string"
},
"street2": {
"description": "Updated secondary street address.",
"type": "string"
},
"type": {
"description": "Updated address type.",
"enum": [
"BILLING",
"SHIPPING",
"MAILING",
"REGISTERED"
],
"type": "string"
}
},
"required": [
"addressId"
],
"type": "object"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "agent_update",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Register a custom sending domain in the workspace so it can be configured for email traffic. Use this before DNS setup and verification.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"domain": {
"description": "Domain name to add, such as mail.example.com or example.com.",
"type": "string"
}
},
"required": [
"domain"
],
"type": "object"
},
"name": "domain_create",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Delete a domain from the workspace when it is no longer needed. Use this to remove old or incorrect domain configurations.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "Unique domain ID.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "domain_delete",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"deleted": {
"type": "boolean"
},
"id": {
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Fetch full detail for a single domain by ID, including verification and configuration state. Use domain_list to browse all domains.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "Unique domain ID.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "domain_get",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "List all domains connected to the current workspace. Use this to audit configured sender domains and choose one for follow-up actions.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "domain_list",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"count": {
"type": "number"
},
"cursor": {
"type": [
"string",
"null"
]
},
"has_more": {
"type": "boolean"
},
"items": {
"items": {},
"type": "array"
},
"next_offset": {
"type": "number"
},
"total": {
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Update mutable configuration on a domain. Currently the only updatable field is `feedbackEnabled` — toggle SES bounce and complaint feedback processing on or off without re-verifying the domain.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"feedbackEnabled": {
"description": "Enable or disable bounce + complaint feedback processing for this domain.",
"type": "boolean"
},
"id": {
"description": "Unique domain ID.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "domain_update",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Trigger a verification check for a domain after DNS records are configured. Use this to re-run DNS validation and update verification status.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "Unique domain ID.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "domain_verify",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Get the full DNS zone file for a domain. Use this for complete DNS export or to verify all records are correctly configured.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "Unique domain ID.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "domain_zone_file",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Get a temporary download URL for an email attachment. Use this when you need direct file access for preview or download.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "Attachment ID. Returns a temporary download URL.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "email_attachment_get",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Create a new email draft (composed but not sent). Drafts can be incomplete — missing recipients, subject, or body. Use email_draft_send later to actually deliver, or email_draft_delete to discard.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Owning agent ID.",
"type": "string"
},
"bcc": {
"description": "BCC recipients.",
"items": {
"type": "string"
},
"type": "array"
},
"body": {
"description": "Plain-text body.",
"type": "string"
},
"bodyHtml": {
"description": "HTML body.",
"type": "string"
},
"cc": {
"description": "CC recipients.",
"items": {
"type": "string"
},
"type": "array"
},
"fromIdentityId": {
"description": "Optional EmailIdentity ID to send from. Must belong to this agent and be verified. If omitted, the agent's primary identity is used at send time. Discover available IDs from the `emailIdentities` array returned by agent_get.",
"type": "string"
},
"inReplyTo": {
"description": "Optional In-Reply-To Message-ID for threading on send.",
"type": "string"
},
"metadata": {
"additionalProperties": {},
"description": "Arbitrary metadata.",
"type": "object"
},
"references": {
"description": "Optional References chain for threading.",
"items": {
"type": "string"
},
"type": "array"
},
"subject": {
"description": "Subject line.",
"type": "string"
},
"to": {
"description": "Recipient email addresses (may be empty for an incomplete draft).",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"agentId"
],
"type": "object"
},
"name": "email_draft_create",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Discard a draft. Use this to remove drafts that are no longer needed. Use email_draft_send if you want to deliver instead.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "Draft ID.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "email_draft_delete",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"deleted": {
"type": "boolean"
},
"id": {
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Fetch full detail for a single draft by ID. Use email_draft_list to browse drafts.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "Draft ID.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "email_draft_get",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "List email drafts with optional filters. Returns lightweight draft records — use email_draft_get for full detail.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Filter drafts by agent ID.",
"type": "string"
},
"cursor": {
"description": "Pagination cursor from a previous list response.",
"type": "string"
},
"limit": {
"description": "Max drafts when listing. Ignored when `id` is provided.",
"exclusiveMinimum": 0,
"type": "integer"
}
},
"type": "object"
},
"name": "email_draft_list",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"count": {
"type": "number"
},
"cursor": {
"type": [
"string",
"null"
]
},
"has_more": {
"type": "boolean"
},
"items": {
"items": {},
"type": "array"
},
"next_offset": {
"type": "number"
},
"total": {
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Send a draft. Atomically converts the draft to a delivered Message + deletes the draft row. The draft must have at least one recipient, a subject, and a body. Returns the newly-created Message.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "Draft ID.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "email_draft_send",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"id": {
"type": "string"
},
"messageId": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Forward an existing email to another recipient by loading the original content first. Use this to share a prior message while preserving context.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Agent ID forwarding the email.",
"type": "string"
},
"attachments": {
"description": "Optional additional file attachments on the forward (max 20 entries, 25MB total). Original email's attachments are NOT auto-included — pass them explicitly if you want them forwarded.",
"items": {
"additionalProperties": false,
"description": "File attachment for outbound email. Provide exactly one of `content` (base64-inline) or `url` (server-fetch).",
"properties": {
"content": {
"description": "Base64-encoded attachment bytes. Provide either `content` or `url`. Max ~33MB on the wire (decodes to ~25MB binary).",
"type": "string"
},
"contentId": {
"description": "Content-ID for inline attachments referenced in the HTML body via `cid:<id>` (e.g. set to 'logo' for `<img src=\"cid:logo\">`). Present → `Content-Disposition: inline`; absent → `attachment`.",
"type": "string"
},
"contentType": {
"description": "MIME type. Auto-detected from `filename` extension if omitted (e.g. 'application/pdf' for .pdf). Falls back to 'application/octet-stream'.",
"type": "string"
},
"filename": {
"description": "Filename presented to the recipient. Inferred from URL path when `url` is used and this is omitted; falls back to 'attachment'.",
"type": "string"
},
"url": {
"description": "Public URL the server fetches and attaches. Provide either `content` or `url`. Private/loopback/link-local IPs are rejected (SSRF guard). Max 25MB after download.",
"type": "string"
}
},
"type": "object"
},
"maxItems": 20,
"type": "array"
},
"originalId": {
"description": "Original email ID being forwarded.",
"type": "string"
},
"text": {
"description": "Optional introductory text to prepend before forwarded content.",
"type": "string"
},
"to": {
"description": "Recipient email address(es) for the forwarded message.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"agentId",
"originalId",
"to"
],
"type": "object"
},
"name": "email_forward",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"id": {
"type": "string"
},
"messageId": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Fetch full detail for a single email by ID, including metadata and body. Use email_list to browse emails in a folder.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "Email ID. Returns full metadata and body.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "email_get",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Add and/or remove labels on one message — the agent's workflow state. Use this to mark mail read/unread (`read`/`unread`), archive it (`archived`), or apply your own tags, then filter with email_list's `labels`. Supply at least one of addLabels/removeLabels. One message per call: there is no batch form.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"addLabels": {
"description": "Labels to add. Adding `read` removes `unread` and vice versa — one state under two names, and a message always carries exactly one of them.",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"description": "ID of the message to relabel.",
"type": "string"
},
"removeLabels": {
"description": "Labels to remove. Removing `unread` marks the message read (and vice versa); a message is never left with neither.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "email_label",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "List emails with cursor pagination. Returns lightweight per-email records plus a `pagination` object — pass `pagination.nextCursor` back as `cursor` for the next page. Use email_get for the full body, email_search to find specific messages.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Filter emails by agent ID. Agent-scoped keys are already limited to their own agent; master keys see the whole workspace unless filtered.",
"type": "string"
},
"cursor": {
"description": "Opaque pagination cursor from a previous response's `pagination.nextCursor`. Omit for the first page.",
"type": "string"
},
"includeSpam": {
"description": "Include messages classified as spam on arrival. Excluded by default. Naming `spam` in `labels` also counts as asking for it.",
"type": "boolean"
},
"labels": {
"description": "Only return messages carrying ALL of these labels. System labels: `unread`, `read`, `archived`, `spam`. Case-insensitive. Use email_label to change them.",
"items": {
"type": "string"
},
"type": "array"
},
"limit": {
"description": "Max emails to return per page (1-100, default 20).",
"exclusiveMinimum": 0,
"type": "integer"
}
},
"type": "object"
},
"name": "email_list",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"count": {
"type": "number"
},
"cursor": {
"type": [
"string",
"null"
]
},
"has_more": {
"type": "boolean"
},
"items": {
"items": {},
"type": "array"
},
"next_offset": {
"type": "number"
},
"total": {
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Reply to an existing email thread by first loading the original message and setting threading headers. Use this when you need a proper in-thread response.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Agent ID sending the reply.",
"type": "string"
},
"attachments": {
"description": "Optional file attachments on the reply (max 20 entries, 25MB total).",
"items": {
"additionalProperties": false,
"description": "File attachment for outbound email. Provide exactly one of `content` (base64-inline) or `url` (server-fetch).",
"properties": {
"content": {
"description": "Base64-encoded attachment bytes. Provide either `content` or `url`. Max ~33MB on the wire (decodes to ~25MB binary).",
"type": "string"
},
"contentId": {
"description": "Content-ID for inline attachments referenced in the HTML body via `cid:<id>` (e.g. set to 'logo' for `<img src=\"cid:logo\">`). Present → `Content-Disposition: inline`; absent → `attachment`.",
"type": "string"
},
"contentType": {
"description": "MIME type. Auto-detected from `filename` extension if omitted (e.g. 'application/pdf' for .pdf). Falls back to 'application/octet-stream'.",
"type": "string"
},
"filename": {
"description": "Filename presented to the recipient. Inferred from URL path when `url` is used and this is omitted; falls back to 'attachment'.",
"type": "string"
},
"url": {
"description": "Public URL the server fetches and attaches. Provide either `content` or `url`. Private/loopback/link-local IPs are rejected (SSRF guard). Max 25MB after download.",
"type": "string"
}
},
"type": "object"
},
"maxItems": 20,
"type": "array"
},
"html": {
"description": "Optional HTML content for the reply body.",
"type": "string"
},
"originalId": {
"description": "Original email ID being replied to.",
"type": "string"
},
"replyAll": {
"description": "When true, include additional participants from the original email.",
"type": "boolean"
},
"text": {
"description": "Plain-text content for your reply message.",
"type": "string"
}
},
"required": [
"agentId",
"originalId",
"text"
],
"type": "object"
},
"name": "email_reply",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"id": {
"type": "string"
},
"messageId": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Search messages by content. Fulltext mode (default) substring-matches subject/body/addresses of EMAIL messages and returns `{items, pagination}` with cursor paging. Semantic mode ranks by vector-embedding similarity and returns `{results}` scored 0-1 — each result spans ANY channel (check the `channel` field) and includes the message id for email_get / email_thread_get follow-ups.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Filter results to a specific agent.",
"type": "string"
},
"cursor": {
"description": "Pagination cursor from a previous fulltext response's `pagination.nextCursor`. Fulltext mode only.",
"type": "string"
},
"includeSpam": {
"description": "Include messages classified as spam on arrival. Excluded by default. Naming `spam` in `labels` also counts as asking for it.",
"type": "boolean"
},
"labels": {
"description": "Only return messages carrying ALL of these labels. System labels: `unread`, `read`, `archived`, `spam`. Case-insensitive. Use email_label to change them.",
"items": {
"type": "string"
},
"type": "array"
},
"limit": {
"description": "Max results (fulltext: 1-100, default 20; semantic: 1-50, default 10).",
"exclusiveMinimum": 0,
"type": "integer"
},
"mode": {
"description": "Search mode. `fulltext` (default) does substring matching over subject/body/addresses of EMAIL messages and supports cursor pagination. `semantic` ranks by vector-embedding similarity — better for meaning-level questions (\"emails about the contract renewal\") — but searches messages across ALL channels (each result carries a `channel` field) and does not paginate.",
"enum": [
"fulltext",
"semantic"
],
"type": "string"
},
"query": {
"description": "Search query text.",
"minLength": 1,
"type": "string"
},
"threshold": {
"description": "Minimum similarity score 0-1 (semantic mode only, default 0.7).",
"maximum": 1,
"minimum": 0,
"type": "number"
}
},
"required": [
"query"
],
"type": "object"
},
"name": "email_search",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Send a new outbound email from the agent mailbox. Use this when you need to compose and deliver a message with optional CC, threading headers.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Agent ID sending the email.",
"type": "string"
},
"attachments": {
"description": "Optional file attachments (max 20 entries, 25MB total). Each entry must provide either `content` (base64-inline) or `url` (public URL for server-fetch). Use `contentId` for inline images referenced in HTML via `cid:` URIs.",
"items": {
"additionalProperties": false,
"description": "File attachment for outbound email. Provide exactly one of `content` (base64-inline) or `url` (server-fetch).",
"properties": {
"content": {
"description": "Base64-encoded attachment bytes. Provide either `content` or `url`. Max ~33MB on the wire (decodes to ~25MB binary).",
"type": "string"
},
"contentId": {
"description": "Content-ID for inline attachments referenced in the HTML body via `cid:<id>` (e.g. set to 'logo' for `<img src=\"cid:logo\">`). Present → `Content-Disposition: inline`; absent → `attachment`.",
"type": "string"
},
"contentType": {
"description": "MIME type. Auto-detected from `filename` extension if omitted (e.g. 'application/pdf' for .pdf). Falls back to 'application/octet-stream'.",
"type": "string"
},
"filename": {
"description": "Filename presented to the recipient. Inferred from URL path when `url` is used and this is omitted; falls back to 'attachment'.",
"type": "string"
},
"url": {
"description": "Public URL the server fetches and attaches. Provide either `content` or `url`. Private/loopback/link-local IPs are rejected (SSRF guard). Max 25MB after download.",
"type": "string"
}
},
"type": "object"
},
"maxItems": 20,
"type": "array"
},
"bcc": {
"description": "Optional BCC recipient email addresses.",
"items": {
"type": "string"
},
"type": "array"
},
"body": {
"description": "Plain-text body content for the email.",
"type": "string"
},
"bodyHtml": {
"description": "Optional HTML body content for rich email formatting.",
"type": "string"
},
"cc": {
"description": "Optional CC recipient email addresses.",
"items": {
"type": "string"
},
"type": "array"
},
"fromIdentityId": {
"description": "Optional EmailIdentity ID to send from. Must belong to this agent and be verified. If omitted, the agent's primary identity is used. Use this to route different message types through different identities (e.g. transactional from @brawz.ai, support from @support.brawz.ai). Discover available IDs from the `emailIdentities` array returned by agent_get.",
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "Optional custom email headers as key-value pairs (e.g. {\"X-Campaign\": \"onboarding\"}). Merged with Anima's own threading/compliance headers, which win on conflict.",
"type": "object"
},
"inReplyTo": {
"description": "Optional message ID to set the In-Reply-To header for threading.",
"type": "string"
},
"references": {
"description": "Optional list of message IDs to include in the References header.",
"items": {
"type": "string"
},
"type": "array"
},
"subject": {
"description": "Subject line for the outgoing email.",
"type": "string"
},
"to": {
"description": "List of recipient email addresses.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"agentId",
"to",
"subject",
"body"
],
"type": "object"
},
"name": "email_send",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"id": {
"type": "string"
},
"messageId": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Fetch all email messages in one or more threads. Pass `id` for a single thread or `ids` for multiple. Returns messages ordered within each thread. Uses the messages endpoint filtered by threadId + channel=EMAIL under the hood.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Optional agent scope filter (only return messages owned by this agent).",
"type": "string"
},
"id": {
"description": "Single thread ID to fetch. Pass either `id` or `ids`.",
"type": "string"
},
"ids": {
"description": "Multiple thread IDs to fetch in parallel. Pass either `id` or `ids`.",
"items": {
"type": "string"
},
"type": "array"
},
"limit": {
"description": "Optional max messages per thread.",
"exclusiveMinimum": 0,
"type": "integer"
}
},
"type": "object"
},
"name": "email_thread_get",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Create a short-lived, single-use connect URL that links a browser extension (or a headless Puppeteer worker) to an Anima agent. Returns `connectUrl` — hand it to the extension to complete the handshake before `exchangeExpiresAt`. The response carries no token or secret. Auth: with a master key you MUST pass `agentId`; with an agent key OMIT `agentId` (the server resolves it from the key). `ttl` is optional; a value above the org's maximum is rejected.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Agent to connect the extension to. REQUIRED when authenticating with a master key (mk_); OMIT when using an agent key (ak_/oat_) — the server resolves the agent from the key.",
"type": "string"
},
"ttl": {
"description": "Requested lifetime of the connection. A value longer than the org's policy maximum is rejected (not silently shortened); omit to use the policy default.",
"enum": [
"15m",
"1h",
"session"
],
"type": "string"
}
},
"type": "object"
},
"name": "extension_connect",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"agentId": {
"type": "string"
},
"connectUrl": {
"type": "string"
},
"exchangeExpiresAt": {
"type": "string"
},
"expiresAt": {
"type": [
"string",
"null"
]
},
"policy": {
"enum": [
"session",
"pre_approved"
],
"type": "string"
}
},
"required": [
"agentId",
"connectUrl",
"expiresAt",
"exchangeExpiresAt",
"policy"
],
"type": "object"
}
},
{
"description": "Create a new email inbox (mailbox) that can receive mail immediately at its address. Choose a username and domain or let the platform generate them. Requires master key access.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Agent ID to associate with this inbox. Inbound mail to the inbox is attributed to this agent.",
"type": "string"
},
"displayName": {
"description": "Human-readable display name for the inbox (max 128 characters).",
"maxLength": 128,
"type": "string"
},
"domain": {
"description": "Domain for the inbox address. Uses the platform default (agents.useanima.sh) when omitted. Custom domains must already be registered and verified — see domain_list.",
"type": "string"
},
"username": {
"description": "Local part of the inbox email address (letters, numbers, dots, hyphens, underscores; normalized to lowercase; must not start/end with a dot or hyphen). A random local part is generated when omitted.",
"maxLength": 64,
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"name": "inbox_create",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Permanently delete an inbox and its mailbox. Mail sent to the address after deletion bounces. This cannot be undone. Requires master key access.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "Unique inbox ID.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "inbox_delete",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"deleted": {
"type": "boolean"
},
"id": {
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Fetch full detail for a single inbox by ID, including its email address, display name, and associated agent. Use inbox_list to browse all inboxes.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "Unique inbox ID.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "inbox_get",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "List inboxes in the workspace with cursor pagination and optional free-text search. Returns the address, display name, and agent association for each inbox.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "Pagination cursor from a previous list response (pagination.nextCursor).",
"type": "string"
},
"limit": {
"description": "Max inboxes to return per page (1-100, default 20).",
"exclusiveMinimum": 0,
"type": "integer"
},
"query": {
"description": "Free-text search filter matched against inbox email addresses and display names.",
"type": "string"
}
},
"type": "object"
},
"name": "inbox_list",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"count": {
"type": "number"
},
"cursor": {
"type": [
"string",
"null"
]
},
"has_more": {
"type": "boolean"
},
"items": {
"items": {},
"type": "array"
},
"next_offset": {
"type": "number"
},
"total": {
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Update the display name or agent association of an inbox. Pass null for a field to clear it (unlink the agent / remove the display name); omitted fields are left unchanged. The email address itself cannot be changed. Requires master key access.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Agent ID to associate with the inbox. Pass null to unlink the current agent. Omit to leave unchanged.",
"type": [
"string",
"null"
]
},
"displayName": {
"anyOf": [
{
"maxLength": 128,
"type": "string"
},
{
"type": "null"
}
],
"description": "New human-readable display name (max 128 characters). Pass null to clear it. Omit to leave unchanged."
},
"id": {
"description": "Unique inbox ID.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "inbox_update",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Place a live phone call and have a real conversation. The tool stays open for the entire call duration. As the caller speaks, you receive live transcript chunks via progress notifications; when the caller finishes a turn (server emits isFinal: true), an elicitation prompt asks you what the agent should say next. You respond with `say` (the exact text to speak) and optional `endCallAfterSpoken: true` to hang up after the line. Returns the full transcript when the call ends. Requires the connecting MCP client to support elicitation — without it, the tool errors out immediately.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentConfig": {
"additionalProperties": false,
"description": "Opt in to the server-side conversation loop. When present (even as `{}`), the Anima API runs the LLM-backed conversation loop on each caller turn and speaks the reply — the MCP tool just records both sides of the transcript and returns it when the call ends. **Required when the connecting MCP client doesn't implement elicitation** (e.g. Claude Code returns `-32600 Elicitation not supported`). Omit ONLY if you have your own bot ready to subscribe to MCP elicitation requests and reply via the `say` field per turn.",
"properties": {
"maxHistoryTurns": {
"description": "Max user+assistant turn pairs the server-side LLM retains in context. Defaults to 20. Long calls drop the oldest turns to keep the model's context window bounded.",
"exclusiveMinimum": 0,
"type": "integer"
},
"systemPrompt": {
"description": "System prompt the server-side LLM uses to shape the agent's persona for this call. Defaults to a generic voice-assistant persona. Max 600 characters (~100 words) — long prompts add 50-150ms per-turn TTFT, the model is rehashing them every reply. Keep responses short and TTS-friendly (no markdown, no bullets); if you override, mirror that guidance.",
"maxLength": 600,
"type": "string"
}
},
"type": "object"
},
"agentId": {
"description": "Required when the API key / OAuth grant is user-bound (no agentId in the auth context, e.g. a master key or a user-consented Anima Connect grant) — picks which of the org's agents places the call. Ignored when the auth is already agent-bound (the bound agent wins; mismatches are rejected with AGENT_MISMATCH). Use agent_list to find valid IDs.",
"type": "string"
},
"firstMessage": {
"description": "Opening line the agent speaks when the call is answered. Be natural — this is what the human hears first.",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"fromNumber": {
"description": "Optional source phone in E.164. Default: the calling agent's primary phone identity.",
"type": "string"
},
"maxDurationSec": {
"description": "Hard cap on total call duration in seconds. Default 600 (10 min). Max 1800 (30 min).",
"exclusiveMinimum": 0,
"maximum": 1800,
"type": "integer"
},
"silenceTimeoutSec": {
"description": "If no caller utterance arrives within this many seconds (measured from the last agent utterance), the call hangs up automatically. Default 30.",
"exclusiveMinimum": 0,
"maximum": 120,
"type": "integer"
},
"to": {
"description": "Destination phone number in E.164 format.",
"pattern": "^\\+[1-9]\\d{7,14}$",
"type": "string"
},
"voiceId": {
"description": "Optional voice override. Use voice_list for valid IDs; the catalog is multilingual and each entry carries an audio preview.",
"type": "string"
}
},
"required": [
"to",
"firstMessage"
],
"type": "object"
},
"name": "phone_call_create",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"callId": {
"description": "ID of the placed call. `null` if the call ended before the carrier assigned an ID (e.g. WS auth failure or pre-ring termination) — use `endedReason` to understand why.",
"type": [
"string",
"null"
]
},
"durationSec": {
"description": "Total call duration in seconds.",
"type": "number"
},
"endedReason": {
"description": "Why the call ended (hangup, timeout, error, etc.).",
"type": "string"
},
"error": {
"additionalProperties": false,
"description": "Present when `endedReason` is `error` or `elicitation_unsupported` — carries the underlying code+message so callers can distinguish capability gaps from real failures.",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object"
},
"latencyTurns": {
"description": "Per-turn latency breakdown captured by the API's LatencyTracker. Each entry is a turn; the t_*_ms fields are absolute millisecond timestamps. Diff adjacent marks to compute stage durations — common ones: perceived_latency_ms = t_speak_dispatch_ms - t_caller_speech_end_ms (basic) or t_tts_first_tx_ms - t_caller_speech_end_ms (premium), endpoint_wait_ms = t_final_ms - t_caller_speech_end_ms, ws_round_trip_ms = t_ws_recv_ms - t_ws_send_ms. Omitted if the API didn't send latency data (pre-Wave-3K servers).",
"items": {
"additionalProperties": false,
"properties": {
"t_backchannel_dispatched_ms": {
"type": "number"
},
"t_caller_speech_end_ms": {
"type": "number"
},
"t_final_ms": {
"type": "number"
},
"t_first_interim_ms": {
"type": "number"
},
"t_session_dispatch_ms": {
"type": "number"
},
"t_speak_dispatch_ms": {
"type": "number"
},
"t_speak_first_chunk_ms": {
"type": "number"
},
"t_tts_complete_ms": {
"type": "number"
},
"t_tts_first_byte_ms": {
"type": "number"
},
"t_tts_first_tx_ms": {
"type": "number"
},
"t_tts_ws_open_ms": {
"type": "number"
},
"t_vad_speech_end_ms": {
"type": "number"
},
"t_ws_recv_ms": {
"type": "number"
},
"t_ws_send_ms": {
"type": "number"
},
"turnId": {
"type": "string"
},
"turnIndex": {
"type": "integer"
}
},
"required": [
"turnId",
"turnIndex"
],
"type": "object"
},
"type": "array"
},
"transcript": {
"description": "Full transcript with role labels in chronological order.",
"items": {
"additionalProperties": false,
"properties": {
"at": {
"description": "ISO 8601 timestamp.",
"type": "string"
},
"role": {
"description": "Who spoke this turn — `caller` is the human, `agent` is the AI.",
"enum": [
"caller",
"agent"
],
"type": "string"
},
"text": {
"type": "string"
},
"turnId": {
"type": "string"
}
},
"required": [
"role",
"text"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"callId",
"endedReason",
"transcript"
],
"type": "object"
}
},
{
"description": "Get full detail for a single phone call: status, duration, participants, AI-generated summary (one-liner, topics, action items, decisions, open questions, next steps), and quality score. The summary is generated once on first read after post-call processing and cached.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "The call ID.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "phone_call_get",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "List phone calls with optional filters. Returns lightweight call records — for full call detail including summary and score, use phone_call_get.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Filter by agent ID.",
"type": "string"
},
"direction": {
"description": "Filter by call direction.",
"enum": [
"INBOUND",
"OUTBOUND"
],
"type": "string"
},
"limit": {
"description": "Max results (default: 20).",
"exclusiveMinimum": 0,
"type": "integer"
},
"offset": {
"description": "Offset for pagination.",
"minimum": 0,
"type": "integer"
},
"status": {
"description": "Filter by call state (INITIATING, RINGING, ACTIVE, ENDED, etc.).",
"type": "string"
}
},
"type": "object"
},
"name": "phone_call_list",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"count": {
"type": "number"
},
"cursor": {
"type": [
"string",
"null"
]
},
"has_more": {
"type": "boolean"
},
"items": {
"items": {},
"type": "array"
},
"next_offset": {
"type": "number"
},
"total": {
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Get a time-limited download URL for a call recording (WAV format). The URL expires after 1 hour. Recording must have been enabled during the call.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "The call ID.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "phone_call_recording_get",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Get the full transcript of a phone call with speaker labels, timestamps, and confidence scores. Available after the call ends and transcription completes.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "The call ID.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "phone_call_transcript_get",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "List phone numbers assigned to an agent. Each result includes status and capability flags (sms/mms/voice).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Agent whose phone numbers to list.",
"type": "string"
}
},
"required": [
"agentId"
],
"type": "object"
},
"name": "phone_number_list",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"count": {
"type": "number"
},
"cursor": {
"type": [
"string",
"null"
]
},
"has_more": {
"type": "boolean"
},
"items": {
"items": {},
"type": "array"
},
"next_offset": {
"type": "number"
},
"total": {
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Provision a new phone number from the carrier pool and assign it to an agent. Note: provisioning a number costs money on the underlying carrier; do not call speculatively. Use countryCode / areaCode / capabilities to constrain selection.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Agent ID to assign the provisioned phone number to.",
"type": "string"
},
"areaCode": {
"description": "Preferred area code for the phone number.",
"type": "string"
},
"capabilities": {
"description": "Optional capability list (sms, mms, voice) the number must support.",
"items": {
"enum": [
"sms",
"mms",
"voice"
],
"type": "string"
},
"type": "array"
},
"countryCode": {
"description": "ISO 3166-1 alpha-2 country code for number selection (default US).",
"type": "string"
}
},
"required": [
"agentId"
],
"type": "object"
},
"name": "phone_number_provision",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Release a previously provisioned phone number back to the carrier pool. Use this when cleaning up unused numbers. Released numbers cannot be recovered.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Agent ID that currently owns the phone number.",
"type": "string"
},
"phoneNumber": {
"description": "E.164 formatted phone number to release.",
"type": "string"
}
},
"required": [
"agentId",
"phoneNumber"
],
"type": "object"
},
"name": "phone_number_release",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"deleted": {
"type": "boolean"
},
"id": {
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Fetch full detail for a single SMS by ID (includes its `threadId` for joining the conversation). Use sms_list to browse multiple SMS messages.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "SMS message ID.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "sms_get",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "List SMS messages with optional filters. Each result includes its `threadId` for joining the conversation. Use sms_get for full single-message detail.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Filter SMS by agent ID.",
"type": "string"
},
"cursor": {
"description": "Pagination cursor from a previous list response.",
"type": "string"
},
"limit": {
"description": "Max SMS messages to return.",
"exclusiveMinimum": 0,
"type": "integer"
}
},
"type": "object"
},
"name": "sms_list",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"count": {
"type": "number"
},
"cursor": {
"type": [
"string",
"null"
]
},
"has_more": {
"type": "boolean"
},
"items": {
"items": {},
"type": "array"
},
"next_offset": {
"type": "number"
},
"total": {
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Send an SMS to a phone number, or an MMS by passing `mediaUrls`. The agent must have a provisioned phone number. Use this for transactional texts or conversational messaging.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Agent ID sending the SMS. The agent must have a provisioned phone number.",
"type": "string"
},
"body": {
"description": "Message body. SMS character limits apply (~160 chars per segment).",
"type": "string"
},
"mediaUrls": {
"description": "Optional array of media URLs for MMS. Pass one URL for a single image/file; multiple for multi-part MMS. Carrier limits apply.",
"items": {
"type": "string"
},
"type": "array"
},
"to": {
"description": "Recipient phone number in E.164 format (e.g. +14155551234).",
"type": "string"
}
},
"required": [
"agentId",
"to",
"body"
],
"type": "object"
},
"name": "sms_send",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"id": {
"type": "string"
},
"messageId": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Get one SMS/MMS conversation with its message history, oldest first. Use sms_thread_list to find thread IDs (or take `threadId` off any SMS). For a conversation longer than `limit`, returns its most recent messages; page deeper history with sms_list.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "Thread ID (use sms_thread_list to find IDs).",
"type": "string"
},
"limit": {
"description": "Max messages to return in the thread.",
"exclusiveMinimum": 0,
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "sms_thread_get",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "List SMS/MMS conversations, most recently active first. A conversation is one agent number talking to one external contact. Returns summaries (participant, last message snippet, message count) — use sms_thread_get for the full history. Optionally filter by agentId.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Filter conversations by agent ID. Omit to see threads across all agents you have access to.",
"type": "string"
},
"limit": {
"description": "Max thread summaries to return. Defaults to 20.",
"exclusiveMinimum": 0,
"type": "integer"
},
"offset": {
"description": "Pagination offset (skip this many threads from the start).",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"name": "sms_thread_list",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"count": {
"type": "number"
},
"cursor": {
"type": [
"string",
"null"
]
},
"has_more": {
"type": "boolean"
},
"items": {
"items": {},
"type": "array"
},
"next_offset": {
"type": "number"
},
"total": {
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Usage rollup for a billing period. Returns counters keyed by usage type (e.g. 'email_sent', 'sms_sent', 'voice_call_minutes') plus the latest update timestamp. Defaults to the current calendar month in UTC when `period` is omitted. Read-only, callable by any authenticated credential — scoped to the caller's org. Use to answer 'where am I against my tier limits?' without paying for per-event detail (UsageEvent is operator-tier).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"period": {
"description": "Billing period in YYYY-MM format (e.g. '2026-05'). Defaults to the current calendar month in UTC.",
"pattern": "^\\d{4}-\\d{2}$",
"type": "string"
}
},
"type": "object"
},
"name": "usage_overview",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Create a new credential in an agent vault. Pass `type` plus the matching payload block (login / card / identity / oauthToken / apiKey / certificate / notes). For login credentials, prefer `generatePassword` over supplying `login.password` — the vault generates and stores the password server-side and returns only the credential reference, so the secret never enters the conversation. For api_key/oauth_token credentials, set `allowedHosts` so the credential can be exercised through vault_credential_use.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Agent ID that owns the new credential. Optional when using an agent-bound credential.",
"type": "string"
},
"apiKey": {
"additionalProperties": false,
"description": "API key payload for api_key-type.",
"properties": {
"allowedHosts": {
"description": "Hosts this key may be brokered to via vault_credential_use. Fail-closed: with no hosts the broker refuses every call. After creation only a master key may change this list.",
"items": {
"type": "string"
},
"type": "array"
},
"authHeader": {
"description": "Header the broker injects the key into (default 'Authorization').",
"type": "string"
},
"authScheme": {
"description": "Value prefix before the key (default 'Bearer '; set '' for a raw key, e.g. x-api-key).",
"type": "string"
},
"expiresAt": {
"description": "Optional ISO-8601 key expiration timestamp.",
"type": "string"
},
"key": {
"description": "The API key value. Stored encrypted; always read back masked.",
"type": "string"
},
"prefix": {
"description": "Optional display prefix (e.g. 'sk-...abc').",
"type": "string"
},
"provider": {
"description": "API provider name (e.g. openai, anthropic, stripe).",
"type": "string"
},
"rateLimit": {
"additionalProperties": false,
"description": "Optional per-credential broker rate limit.",
"properties": {
"requests": {
"description": "Maximum requests allowed in the window.",
"exclusiveMinimum": 0,
"type": "integer"
},
"window": {
"description": "Rate-limit window (e.g. '1m', '1h', '1d').",
"type": "string"
}
},
"required": [
"requests",
"window"
],
"type": "object"
},
"scopes": {
"description": "Optional scopes or permissions this key carries.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"provider",
"key"
],
"type": "object"
},
"card": {
"additionalProperties": false,
"description": "Card payload for card-type.",
"properties": {
"brand": {
"description": "Optional card brand.",
"type": "string"
},
"cardholderName": {
"description": "Optional cardholder name.",
"type": "string"
},
"code": {
"description": "Optional security code.",
"type": "string"
},
"expMonth": {
"description": "Optional expiration month.",
"type": "string"
},
"expYear": {
"description": "Optional expiration year.",
"type": "string"
},
"number": {
"description": "Optional card number.",
"type": "string"
}
},
"type": "object"
},
"certificate": {
"additionalProperties": false,
"description": "Certificate payload for certificate-type.",
"properties": {
"certificate": {
"description": "Certificate content. Stored encrypted.",
"type": "string"
},
"chain": {
"description": "Optional certificate chain.",
"items": {
"type": "string"
},
"type": "array"
},
"expiresAt": {
"description": "ISO-8601 certificate expiration timestamp.",
"type": "string"
},
"format": {
"description": "Certificate format.",
"enum": [
"pem",
"p12",
"jks"
],
"type": "string"
},
"privateKey": {
"description": "Private key. Stored encrypted; always read back masked.",
"type": "string"
}
},
"required": [
"format",
"certificate",
"privateKey",
"expiresAt"
],
"type": "object"
},
"favorite": {
"description": "Optional favorite flag.",
"type": "boolean"
},
"fields": {
"description": "Optional custom fields.",
"items": {
"additionalProperties": false,
"properties": {
"linkedId": {
"description": "Optional linked field identifier.",
"type": "string"
},
"name": {
"description": "Custom field name.",
"type": "string"
},
"type": {
"description": "Optional custom field type.",
"type": "string"
},
"value": {
"description": "Optional custom field value.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"generatePassword": {
"additionalProperties": false,
"description": "Generate the login password server-side instead of supplying login.password. Preferred for login credentials: the password is created and stored inside the vault and never enters the conversation. Only valid for login-type; mutually exclusive with login.password. Pass {} for defaults.",
"properties": {
"length": {
"description": "Desired password length (8-128 characters, default 24).",
"maximum": 128,
"minimum": 8,
"type": "integer"
},
"lowercase": {
"description": "Include lowercase letters (default true).",
"type": "boolean"
},
"number": {
"description": "Include numeric digits (default true).",
"type": "boolean"
},
"special": {
"description": "Include special characters (default true).",
"type": "boolean"
},
"uppercase": {
"description": "Include uppercase letters (default true).",
"type": "boolean"
}
},
"type": "object"
},
"identity": {
"additionalProperties": false,
"description": "Identity payload for identity-type.",
"properties": {
"address1": {
"description": "Optional address line 1.",
"type": "string"
},
"address2": {
"description": "Optional address line 2.",
"type": "string"
},
"address3": {
"description": "Optional address line 3.",
"type": "string"
},
"city": {
"description": "Optional city.",
"type": "string"
},
"company": {
"description": "Optional company name.",
"type": "string"
},
"country": {
"description": "Optional country.",
"type": "string"
},
"email": {
"description": "Optional identity email.",
"type": "string"
},
"firstName": {
"description": "Optional first name.",
"type": "string"
},
"lastName": {
"description": "Optional last name.",
"type": "string"
},
"licenseNumber": {
"description": "Optional license number.",
"type": "string"
},
"middleName": {
"description": "Optional middle name.",
"type": "string"
},
"passportNumber": {
"description": "Optional passport number.",
"type": "string"
},
"phone": {
"description": "Optional identity phone.",
"type": "string"
},
"postalCode": {
"description": "Optional postal code.",
"type": "string"
},
"ssn": {
"description": "Optional SSN or national ID.",
"type": "string"
},
"state": {
"description": "Optional state or province.",
"type": "string"
},
"title": {
"description": "Optional identity title.",
"type": "string"
},
"username": {
"description": "Optional username value.",
"type": "string"
}
},
"type": "object"
},
"login": {
"additionalProperties": false,
"description": "Login payload for login-type.",
"properties": {
"password": {
"description": "Optional login password.",
"type": "string"
},
"totp": {
"description": "Optional TOTP secret.",
"type": "string"
},
"uris": {
"description": "Optional list of login URIs.",
"items": {
"additionalProperties": false,
"properties": {
"match": {
"description": "Optional URI match mode.",
"type": "string"
},
"uri": {
"description": "URI value.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"username": {
"description": "Optional login username.",
"type": "string"
}
},
"type": "object"
},
"name": {
"description": "Human-readable credential name.",
"type": "string"
},
"notes": {
"description": "Optional secure note text.",
"type": "string"
},
"oauthToken": {
"additionalProperties": false,
"description": "OAuth token payload for oauth_token-type.",
"properties": {
"accessToken": {
"description": "OAuth access token. Stored encrypted.",
"type": "string"
},
"allowedHosts": {
"description": "Hosts this token may be brokered to via vault_credential_use. Fail-closed: with no hosts the broker refuses every call.",
"items": {
"type": "string"
},
"type": "array"
},
"autoRefresh": {
"description": "Automatically refresh before expiry (default true).",
"type": "boolean"
},
"clientId": {
"description": "OAuth client ID.",
"type": "string"
},
"clientSecret": {
"description": "Optional OAuth client secret.",
"type": "string"
},
"expiresAt": {
"description": "ISO-8601 token expiration timestamp.",
"type": "string"
},
"provider": {
"description": "OAuth provider name (e.g. google, github, slack).",
"type": "string"
},
"refreshToken": {
"description": "OAuth refresh token. Stored encrypted; never read back.",
"type": "string"
},
"scopes": {
"description": "OAuth scopes granted to this token.",
"items": {
"type": "string"
},
"type": "array"
},
"tokenEndpoint": {
"description": "Token endpoint URL used for automatic refresh.",
"type": "string"
}
},
"required": [
"provider",
"accessToken",
"refreshToken",
"tokenEndpoint",
"clientId",
"scopes",
"expiresAt"
],
"type": "object"
},
"revealPolicy": {
"description": "Reveal policy. 'brokered' means the plaintext is never returned by any read/reveal/export path — not even to the org master key; the secret is only usable via vault_credential_use (recovery = rotation). 'standard' keeps master-key reveal available outside MCP.",
"enum": [
"standard",
"brokered"
],
"type": "string"
},
"type": {
"description": "Credential type.",
"enum": [
"login",
"secure_note",
"card",
"identity",
"oauth_token",
"api_key",
"certificate"
],
"type": "string"
}
},
"required": [
"type",
"name"
],
"type": "object"
},
"name": "vault_credential_create",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Delete a credential from vault storage by ID. Use to remove obsolete or compromised secrets.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Agent ID that owns the credential. Optional when using an agent-bound credential.",
"type": "string"
},
"id": {
"description": "Credential ID.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "vault_credential_delete",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"deleted": {
"type": "boolean"
},
"id": {
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Get a single vault credential by ID. Sensitive fields (passwords, tokens, SSNs, CVV) are masked. To use the plaintext for autofill or as an upstream credential, mint a vault token at the credential broker — the LLM never sees the secret directly.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Agent ID that owns the credential. Optional when using an agent-bound credential.",
"type": "string"
},
"id": {
"description": "Credential ID.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "vault_credential_get",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Get the current TOTP code for a credential that has a TOTP secret configured. Returns the live 6-digit code derived from the stored secret — the secret itself is never disclosed.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Agent ID that owns the credential. Optional when using an agent-bound credential.",
"type": "string"
},
"id": {
"description": "Credential ID.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "vault_credential_get_totp",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "List credentials in an agent vault with optional type filter. Use to browse stored secrets before reading, updating, or deleting entries. Sensitive fields are masked.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Agent ID whose vault to list. Optional when using an agent-bound credential (ak_* or oat_* with agentId).",
"type": "string"
},
"type": {
"description": "Optional credential type filter.",
"enum": [
"login",
"secure_note",
"card",
"identity",
"oauth_token",
"api_key",
"certificate"
],
"type": "string"
}
},
"type": "object"
},
"name": "vault_credential_list",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"count": {
"type": "number"
},
"cursor": {
"type": [
"string",
"null"
]
},
"has_more": {
"type": "boolean"
},
"items": {
"items": {},
"type": "array"
},
"next_offset": {
"type": "number"
},
"total": {
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Cancel a pending credential request by ID. Invalidates the single-use fill link so the human can no longer submit a value. Use when the request is no longer needed or was created in error.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"requestId": {
"description": "Credential-request ID.",
"type": "string"
}
},
"required": [
"requestId"
],
"type": "object"
},
"name": "vault_credential_request_cancel",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Request a credential from a HUMAN without the agent or LLM ever seeing the secret. When the connecting MCP client supports inline elicitation, the human is shown a form to type the secret directly — the tool returns `status: FULFILLED` with the `credentialId` in one call, no link needed. Otherwise it returns a single-use fill link (`fillUrl`, emailed to the org owner); poll vault_credential_request_status until `status` is FULFILLED, then use the returned `credentialId` as a normal vault credential. Use this when a flow needs a secret the agent doesn't hold and can't safely be given (passwords, API keys, card numbers).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Agent ID whose vault the requested credential lands in. Optional when using an agent-bound credential.",
"type": "string"
},
"name": {
"description": "Human-readable name for the requested credential.",
"type": "string"
},
"notifyOwner": {
"description": "Whether to email the single-use fill link to the org owner. Defaults to true.",
"type": "boolean"
},
"reason": {
"description": "Plain-language reason shown to the human explaining why the credential is needed.",
"type": "string"
},
"ttlSeconds": {
"description": "Optional fill-link lifetime in seconds before the request expires.",
"type": "number"
},
"type": {
"description": "Credential type the human will be asked to fill: login, secure_note, or card.",
"enum": [
"login",
"secure_note",
"card"
],
"type": "string"
}
},
"required": [
"type",
"name",
"reason"
],
"type": "object"
},
"name": "vault_credential_request_create",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Internal: submit a credential-request secret from the Anima UI widget. Not for direct agent use.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"fillToken": {
"description": "Single-use fill token from the ui-tier render-data.",
"type": "string"
},
"values": {
"additionalProperties": {
"type": "string"
},
"description": "The secret field values the human entered in the widget.",
"type": "object"
}
},
"required": [
"fillToken",
"values"
],
"type": "object"
},
"name": "vault_credential_request_fill",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Get the status of a pending credential request by ID. Poll this after vault_credential_request_create until `status` is FULFILLED, then use `credentialId` as a normal vault credential. `maskedPreview` shows a redacted hint of the filled value once available — the plaintext is never returned.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"requestId": {
"description": "Credential-request ID.",
"type": "string"
}
},
"required": [
"requestId"
],
"type": "object"
},
"name": "vault_credential_request_status",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Search vault credentials by keyword across names and content. Use when you know part of the name, URL, or username but not the exact credential ID. Different access pattern from vault_credential_list — list is paginated browsing, search is text-query lookup.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Agent ID whose vault to search. Optional when using an agent-bound credential.",
"type": "string"
},
"search": {
"description": "Search text matched against names and content.",
"type": "string"
},
"type": {
"description": "Optional credential type filter.",
"enum": [
"login",
"secure_note",
"card",
"identity",
"oauth_token",
"api_key",
"certificate"
],
"type": "string"
}
},
"required": [
"search"
],
"type": "object"
},
"name": "vault_credential_search",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"count": {
"type": "number"
},
"cursor": {
"type": [
"string",
"null"
]
},
"has_more": {
"type": "boolean"
},
"items": {
"items": {},
"type": "array"
},
"next_offset": {
"type": "number"
},
"total": {
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Update an existing vault credential by ID, including optional structured sections and metadata flags. Use to rotate passwords or revise stored details.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Agent ID that owns the credential. Optional when using an agent-bound credential.",
"type": "string"
},
"apiKey": {
"additionalProperties": false,
"description": "Optional updated API key payload. Changing allowedHosts requires a master key.",
"properties": {
"allowedHosts": {
"description": "Hosts this key may be brokered to via vault_credential_use. Fail-closed: with no hosts the broker refuses every call. After creation only a master key may change this list.",
"items": {
"type": "string"
},
"type": "array"
},
"authHeader": {
"description": "Header the broker injects the key into (default 'Authorization').",
"type": "string"
},
"authScheme": {
"description": "Value prefix before the key (default 'Bearer '; set '' for a raw key, e.g. x-api-key).",
"type": "string"
},
"expiresAt": {
"description": "Optional ISO-8601 key expiration timestamp.",
"type": "string"
},
"key": {
"description": "The API key value. Stored encrypted; always read back masked.",
"type": "string"
},
"prefix": {
"description": "Optional display prefix (e.g. 'sk-...abc').",
"type": "string"
},
"provider": {
"description": "API provider name (e.g. openai, anthropic, stripe).",
"type": "string"
},
"rateLimit": {
"additionalProperties": false,
"description": "Optional per-credential broker rate limit.",
"properties": {
"requests": {
"description": "Maximum requests allowed in the window.",
"exclusiveMinimum": 0,
"type": "integer"
},
"window": {
"description": "Rate-limit window (e.g. '1m', '1h', '1d').",
"type": "string"
}
},
"required": [
"requests",
"window"
],
"type": "object"
},
"scopes": {
"description": "Optional scopes or permissions this key carries.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"provider",
"key"
],
"type": "object"
},
"card": {
"additionalProperties": false,
"description": "Optional updated card payload.",
"properties": {
"brand": {
"description": "Optional card brand.",
"type": "string"
},
"cardholderName": {
"description": "Optional cardholder name.",
"type": "string"
},
"code": {
"description": "Optional security code.",
"type": "string"
},
"expMonth": {
"description": "Optional expiration month.",
"type": "string"
},
"expYear": {
"description": "Optional expiration year.",
"type": "string"
},
"number": {
"description": "Optional card number.",
"type": "string"
}
},
"type": "object"
},
"certificate": {
"additionalProperties": false,
"description": "Optional updated certificate payload.",
"properties": {
"certificate": {
"description": "Certificate content. Stored encrypted.",
"type": "string"
},
"chain": {
"description": "Optional certificate chain.",
"items": {
"type": "string"
},
"type": "array"
},
"expiresAt": {
"description": "ISO-8601 certificate expiration timestamp.",
"type": "string"
},
"format": {
"description": "Certificate format.",
"enum": [
"pem",
"p12",
"jks"
],
"type": "string"
},
"privateKey": {
"description": "Private key. Stored encrypted; always read back masked.",
"type": "string"
}
},
"required": [
"format",
"certificate",
"privateKey",
"expiresAt"
],
"type": "object"
},
"favorite": {
"description": "Optional updated favorite flag.",
"type": "boolean"
},
"fields": {
"description": "Optional updated custom fields.",
"items": {
"additionalProperties": false,
"properties": {
"linkedId": {
"description": "Optional linked field identifier.",
"type": "string"
},
"name": {
"description": "Custom field name.",
"type": "string"
},
"type": {
"description": "Optional custom field type.",
"type": "string"
},
"value": {
"description": "Optional custom field value.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"id": {
"description": "Credential ID to update.",
"type": "string"
},
"identity": {
"additionalProperties": false,
"description": "Optional updated identity payload.",
"properties": {
"address1": {
"description": "Optional address line 1.",
"type": "string"
},
"address2": {
"description": "Optional address line 2.",
"type": "string"
},
"address3": {
"description": "Optional address line 3.",
"type": "string"
},
"city": {
"description": "Optional city.",
"type": "string"
},
"company": {
"description": "Optional company name.",
"type": "string"
},
"country": {
"description": "Optional country.",
"type": "string"
},
"email": {
"description": "Optional identity email.",
"type": "string"
},
"firstName": {
"description": "Optional first name.",
"type": "string"
},
"lastName": {
"description": "Optional last name.",
"type": "string"
},
"licenseNumber": {
"description": "Optional license number.",
"type": "string"
},
"middleName": {
"description": "Optional middle name.",
"type": "string"
},
"passportNumber": {
"description": "Optional passport number.",
"type": "string"
},
"phone": {
"description": "Optional identity phone.",
"type": "string"
},
"postalCode": {
"description": "Optional postal code.",
"type": "string"
},
"ssn": {
"description": "Optional SSN or national ID.",
"type": "string"
},
"state": {
"description": "Optional state or province.",
"type": "string"
},
"title": {
"description": "Optional identity title.",
"type": "string"
},
"username": {
"description": "Optional username value.",
"type": "string"
}
},
"type": "object"
},
"login": {
"additionalProperties": false,
"description": "Optional updated login payload.",
"properties": {
"password": {
"description": "Optional login password.",
"type": "string"
},
"totp": {
"description": "Optional TOTP secret.",
"type": "string"
},
"uris": {
"description": "Optional list of login URIs.",
"items": {
"additionalProperties": false,
"properties": {
"match": {
"description": "Optional URI match mode.",
"type": "string"
},
"uri": {
"description": "URI value.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"username": {
"description": "Optional login username.",
"type": "string"
}
},
"type": "object"
},
"name": {
"description": "Optional updated name.",
"type": "string"
},
"notes": {
"description": "Optional updated note text.",
"type": "string"
},
"oauthToken": {
"additionalProperties": false,
"description": "Optional updated OAuth token payload.",
"properties": {
"accessToken": {
"description": "OAuth access token. Stored encrypted.",
"type": "string"
},
"allowedHosts": {
"description": "Hosts this token may be brokered to via vault_credential_use. Fail-closed: with no hosts the broker refuses every call.",
"items": {
"type": "string"
},
"type": "array"
},
"autoRefresh": {
"description": "Automatically refresh before expiry (default true).",
"type": "boolean"
},
"clientId": {
"description": "OAuth client ID.",
"type": "string"
},
"clientSecret": {
"description": "Optional OAuth client secret.",
"type": "string"
},
"expiresAt": {
"description": "ISO-8601 token expiration timestamp.",
"type": "string"
},
"provider": {
"description": "OAuth provider name (e.g. google, github, slack).",
"type": "string"
},
"refreshToken": {
"description": "OAuth refresh token. Stored encrypted; never read back.",
"type": "string"
},
"scopes": {
"description": "OAuth scopes granted to this token.",
"items": {
"type": "string"
},
"type": "array"
},
"tokenEndpoint": {
"description": "Token endpoint URL used for automatic refresh.",
"type": "string"
}
},
"required": [
"provider",
"accessToken",
"refreshToken",
"tokenEndpoint",
"clientId",
"scopes",
"expiresAt"
],
"type": "object"
},
"revealPolicy": {
"description": "Optional reveal-policy change. Upgrading standard → brokered needs UPDATE access; downgrading brokered → standard is master-key-only.",
"enum": [
"standard",
"brokered"
],
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "vault_credential_update",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Make an outbound HTTPS call with a stored credential attached SERVER-SIDE, and get the upstream response. Use this to act with a secret (call an API, hit an authed endpoint) WITHOUT ever seeing the plaintext — the platform injects the credential on the wire. The target host must be on the credential's allowlist. Works even for `brokered` credentials that can never be revealed. Prefer this over trying to read a secret: you can use it, you cannot see it.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Agent ID that owns the credential. Optional when using an agent-bound credential.",
"type": "string"
},
"body": {
"description": "Raw request body (encode JSON yourself).",
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "Extra request headers. Any Authorization / auth header you set is IGNORED and replaced by the real credential.",
"type": "object"
},
"id": {
"description": "Credential ID to broker the call with.",
"type": "string"
},
"method": {
"description": "HTTP method for the outbound call.",
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"HEAD"
],
"type": "string"
},
"url": {
"description": "Absolute https:// URL to call. Its host MUST be on the credential's allowlist (allowedHosts / login URIs).",
"format": "uri",
"type": "string"
}
},
"required": [
"id",
"method",
"url"
],
"type": "object"
},
"name": "vault_credential_use",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Exchange a vtk_ vault token for the PLAINTEXT credential, to inject into a trusted client process (a CLI, the browser extension) — NOT to read it yourself. The API gates this to injector credentials: it only succeeds for a master key or a key carrying the `vault:inject` scope; a plain agent key gets 403. If you are an agent that needs to USE a secret, do NOT use this — use vault_credential_use (the server-side broker), which never reveals the secret.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"token": {
"description": "The vtk_ vault token to exchange.",
"type": "string"
}
},
"required": [
"token"
],
"type": "object"
},
"name": "vault_exchange_token_for_injection",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Provision a credential vault for an agent. Required before vault_credential_create can be called against a freshly-created agent — without a vault, credentials have nowhere to live. Idempotent: returns the existing vault if one already exists. Master-key only.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"agentId": {
"description": "Agent ID to provision a vault for. Master-key only.",
"type": "string"
}
},
"required": [
"agentId"
],
"type": "object"
},
"name": "vault_provision",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "List available AI voices for placing phone calls. The catalog is multilingual — filter by language or gender. Each voice includes descriptive metadata and a vendor-neutral audio preview URL (sampleUrl), plus the voice ID needed for phone_call_create.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"gender": {
"description": "Filter by voice gender.",
"enum": [
"male",
"female",
"neutral"
],
"type": "string"
},
"language": {
"description": "Filter by BASE language code — the bare two-letter code, e.g. 'en' or 'fr'. Matching is a prefix test against the catalog's own base codes, so a region tag like 'en-US' matches nothing. Call without a filter to see which languages the catalog currently carries.",
"type": "string"
}
},
"type": "object"
},
"name": "voice_list",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"count": {
"type": "number"
},
"cursor": {
"type": [
"string",
"null"
]
},
"has_more": {
"type": "boolean"
},
"items": {
"items": {},
"type": "array"
},
"next_offset": {
"type": "number"
},
"total": {
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Delete a webhook subscription by ID. Permanently removes the configuration and stops future deliveries. To temporarily pause without deleting, use webhook_set with { id, active: false }.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "Webhook ID",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "webhook_delete",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"deleted": {
"type": "boolean"
},
"id": {
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Get a webhook subscription by ID. Returns the full configuration (URL, subscribed events, active state, description).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "Webhook ID",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "webhook_get",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "List webhook subscriptions for the calling org with cursor pagination. Use to enumerate existing webhooks before set/delete operations.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "Pagination cursor from a previous list call",
"type": "string"
},
"limit": {
"description": "Maximum number of webhooks to return (1-100)",
"exclusiveMinimum": 0,
"maximum": 100,
"type": "integer"
}
},
"type": "object"
},
"name": "webhook_list",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {
"count": {
"type": "number"
},
"cursor": {
"type": [
"string",
"null"
]
},
"has_more": {
"type": "boolean"
},
"items": {
"items": {},
"type": "array"
},
"next_offset": {
"type": "number"
},
"total": {
"type": "number"
}
},
"type": "object"
}
},
{
"description": "Create or update a webhook subscription (upsert). If `id` is provided the call updates that webhook (PUT). If omitted it creates a new one (POST) — `url` and `events` are then required. Use this for declarative 'ensure webhook X exists' workflows.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"active": {
"description": "Whether the webhook is active. Defaults to true on create.",
"type": "boolean"
},
"authConfig": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"type": {
"const": "none",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"token": {
"description": "Sent as `Authorization: Bearer <token>`",
"maxLength": 4096,
"minLength": 1,
"type": "string"
},
"type": {
"const": "bearer",
"type": "string"
}
},
"required": [
"type",
"token"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"password": {
"maxLength": 1024,
"minLength": 1,
"type": "string"
},
"type": {
"const": "basic",
"type": "string"
},
"username": {
"maxLength": 256,
"minLength": 1,
"type": "string"
}
},
"required": [
"type",
"username",
"password"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"headerName": {
"description": "Custom header name, e.g. `X-My-Secret`",
"maxLength": 128,
"minLength": 1,
"pattern": "^[A-Za-z0-9!#$%&'*+.^_`|~-]+$",
"type": "string"
},
"type": {
"const": "custom_header",
"type": "string"
},
"value": {
"maxLength": 4096,
"minLength": 1,
"type": "string"
}
},
"required": [
"type",
"headerName",
"value"
],
"type": "object"
}
],
"description": "Auth the platform presents to your endpoint IN ADDITION to the always-on X-Anima-Signature HMAC — a bearer token, HTTP basic, or a custom header. Pass { type: 'none' } to remove it."
},
"description": {
"description": "Optional human-readable label",
"type": "string"
},
"events": {
"description": "List of event types to subscribe to (e.g. 'message.received', 'email.bounced'). Required on create; optional on update.",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"description": "Webhook ID. Present → updates that webhook (PUT). Omitted → creates a new one (POST).",
"type": "string"
},
"maxAttempts": {
"description": "Max delivery attempts before dead-lettering (default 3)",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"rateLimitPerMinute": {
"description": "Max deliveries per minute to this endpoint; omit for unlimited",
"exclusiveMinimum": 0,
"maximum": 100000,
"type": "integer"
},
"url": {
"description": "HTTPS endpoint URL that will receive event payloads. Required on create; optional on update.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"name": "webhook_set",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
},
{
"description": "Send a test event payload to a webhook to verify the endpoint is reachable and signature verification works. Returns a deliveryId you can correlate with your endpoint's logs.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"event": {
"description": "Event type to simulate in the test payload (e.g. 'message.received'). Defaults to 'message.received'.",
"type": "string"
},
"id": {
"description": "Webhook ID to send a test delivery to",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "webhook_test",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": true,
"properties": {},
"type": "object"
}
}
]
}Verify it yourself
curl -s https://api.teppi.xyz/v1/evidence/sha256:01f2f704112f2cf89c00daafdb4007bdc8a50c377928b419781334af673055fd | sha256sum