Server definition
- Hash
- sha256:79e44b00dfffd61bb36ffcc0dbf22f4dc5ad6352f73dc56128971f96d92391ee
- What it is
- What a remote MCP server returned when asked what it offers: 42 tools
The blob, as servednamed by its sha256
{
"instructions": "On human-requested logout/reconnect, call disconnect BEFORE MCP client logout/login. After login, restart or reload the client; before sending, verify connection_info owner.id (public User ID) and handle match the approved account and robot. Stop on mismatch. PingRoom reaches humans by phone with urgent Pings, questions, approvals, handoffs, and live progress. No app? Offer https://pingroom.io/i; install is not consent, so wait for the human to claim the robot. Send success means PingRoom accepted delivery work; it does not prove a person received, saw, or acted. Pending, timeout, enqueued, delivery, and push-receipt states are not answers. For verified input, ask/request then get/wait. Reuse correlation_id for live_status; end it with done or failed.",
"tools": [
{
"description": "Start or resume the onboarding Question in the private room the human chose during authorization. If recipient_not_ready, ask the human to install or update PingRoom from install_url, open the app, sign in, and enable notifications before retrying. Read question.id, then call wait_for_handoff only while state is pending and within a bounded local deadline. Success is answered with activation_completed true. Any other terminal result is incomplete: stop polling that attempt, then call activate_agent_inbox again for one numbered retry. The stamp requires native phone receipt before the human answer.",
"inputSchema": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"name": "activate_agent_inbox",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Ask a person a question with 2-4 tappable options, then block on their answer (pair with wait_for_answer). Delivered as a push they can answer from the lock screen or in-app; the first valid answer wins. Rate-limited.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"attachment_ids": {
"description": "Ids of up to 4 uploaded attachments (see upload_attachment) to include. Uploading requires a Pro account.",
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 4,
"type": "array"
},
"context": {
"description": "Optional secondary line, e.g. a build number.",
"maxLength": 40,
"type": "string"
},
"correlation_id": {
"description": "Your own id, echoed back unchanged on read.",
"maxLength": 255,
"type": "string"
},
"data": {
"additionalProperties": true,
"description": "Arbitrary structured context (max 25 keys / 8KB). Read surfaces return it after connector privacy filtering; do not put secrets in data. data.location is reserved for a shareable location.",
"maxProperties": 25,
"properties": {
"location": {
"additionalProperties": false,
"description": "A shareable geographic location.",
"properties": {
"address": {
"description": "Optional formatted street address.",
"maxLength": 255,
"type": "string"
},
"label": {
"description": "Optional place name shown to the recipient.",
"maxLength": 100,
"type": "string"
},
"latitude": {
"description": "Latitude in decimal degrees.",
"maximum": 90,
"minimum": -90,
"type": "number"
},
"longitude": {
"description": "Longitude in decimal degrees.",
"maximum": 180,
"minimum": -180,
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object"
}
},
"type": "object"
},
"idempotency_key": {
"description": "Stable key so a retried call cannot create a second one.",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"invite_code": {
"description": "Room invite code.",
"type": "string"
},
"options": {
"description": "Answer options in display order. Omit for a default Approve/Deny.",
"items": {
"additionalProperties": false,
"properties": {
"label": {
"description": "Button text shown to the person.",
"maxLength": 40,
"type": "string"
},
"style": {
"description": "primary = affirmative (brand color), danger = destructive (red), default = quiet.",
"enum": [
"primary",
"danger",
"default"
],
"type": "string"
},
"value": {
"description": "Stable token returned as the answer.",
"maxLength": 40,
"type": "string"
}
},
"required": [
"value",
"label"
],
"type": "object"
},
"maxItems": 4,
"minItems": 2,
"type": "array"
},
"prompt": {
"description": "The question the person reads.",
"maxLength": 500,
"type": "string"
},
"reply_to": {
"description": "Optional routing pointer, echoed back unchanged.",
"maxLength": 255,
"type": "string"
},
"text_input": {
"additionalProperties": false,
"description": "Invite a typed answer (on its own, or alongside options). max_length is capped at 60.",
"properties": {
"max_length": {
"description": "Max characters (default 60).",
"maximum": 60,
"minimum": 1,
"type": "integer"
},
"placeholder": {
"description": "Hint shown in the reply field.",
"maxLength": 60,
"type": "string"
}
},
"type": "object"
},
"ttl": {
"description": "Seconds the question stays open before it expires.",
"minimum": 1,
"type": "integer"
}
},
"required": [
"invite_code",
"prompt"
],
"type": "object"
},
"name": "ask_question",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Send a custom ping to a room the account belongs to. Rate-limited. Not available in personal rooms (use trigger_quick_action there).",
"inputSchema": {
"additionalProperties": false,
"properties": {
"ack_mode": {
"description": "With requires_ack: any (default) resolves on the first confirmation; all waits for every original eligible recipient. Read action_state.confirmed_count and required_count for progress.",
"enum": [
"any",
"all"
],
"type": "string"
},
"ack_timeout_seconds": {
"description": "Optional acknowledgement deadline in seconds.",
"maximum": 86400,
"minimum": 60,
"type": "integer"
},
"action_icon": {
"description": "Optional emoji shown with the ping.",
"maxLength": 50,
"type": "string"
},
"action_number": {
"description": "Optional quick-action slot to attribute the ping to.",
"maximum": 16,
"minimum": 1,
"type": "integer"
},
"attachment_ids": {
"description": "Ids of up to 4 uploaded attachments (see upload_attachment) to include. Uploading requires a Pro account.",
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 4,
"type": "array"
},
"correlation_id": {
"description": "Your own id, echoed back unchanged on read.",
"maxLength": 255,
"type": "string"
},
"data": {
"additionalProperties": true,
"description": "Arbitrary structured context (max 25 keys / 8KB). Read surfaces return it after connector privacy filtering; do not put secrets in data. data.location is reserved for a shareable location, and data.url + data.button_label are reserved for a tappable link ping.",
"maxProperties": 25,
"properties": {
"button_label": {
"description": "Reserved: label for the link button rendered for data.url.",
"maxLength": 26,
"type": "string"
},
"label": {
"description": "Reserved: short caption shown with the link ping.",
"maxLength": 26,
"type": "string"
},
"location": {
"additionalProperties": false,
"description": "A shareable geographic location.",
"properties": {
"address": {
"description": "Optional formatted street address.",
"maxLength": 255,
"type": "string"
},
"label": {
"description": "Optional place name shown to the recipient.",
"maxLength": 100,
"type": "string"
},
"latitude": {
"description": "Latitude in decimal degrees.",
"maximum": 90,
"minimum": -90,
"type": "number"
},
"longitude": {
"description": "Longitude in decimal degrees.",
"maximum": 180,
"minimum": -180,
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object"
},
"url": {
"description": "Reserved: an absolute http:// or https:// URL. Present turns the ping into a tappable link.",
"format": "uri",
"maxLength": 2048,
"type": "string"
}
},
"type": "object"
},
"invite_code": {
"description": "Room invite code.",
"type": "string"
},
"is_urgent": {
"description": "Deliver time-sensitive so the ping breaks through Focus / Do Not Disturb and reaches members who muted the room or you (a block still wins). Independent of requires_ack: urgent affects delivery only and asks nothing of the recipient.",
"type": "boolean"
},
"message": {
"description": "Ping body text (max 120 characters in private rooms, 160 in public rooms).",
"maxLength": 160,
"type": "string"
},
"reply_to": {
"description": "Id of the ping this one answers (notification id or correlation id).",
"maxLength": 255,
"type": "string"
},
"requires_ack": {
"description": "Keep this ping open until its confirmation rule is met, and show it as a lock-screen card with an Acknowledge button. Does not raise the interruption level on its own — combine with is_urgent for an ack that also breaks through Focus.",
"type": "boolean"
},
"title": {
"description": "Optional headline. Defaults to the room name.",
"maxLength": 40,
"type": "string"
}
},
"required": [
"invite_code",
"message"
],
"type": "object"
},
"name": "broadcast",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"additionalProperties": true,
"description": "A privacy-minimized, chainable PingRoom notification result.",
"properties": {
"action_state": {
"type": "object"
},
"attachments": {
"type": "array"
},
"correlation_id": {
"type": [
"string",
"null"
]
},
"data": {
"additionalProperties": true,
"description": "Structured context after connector privacy filtering. Credential, account, and direct-contact fields are removed.",
"maxProperties": 25,
"type": "object"
},
"delivery_state": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"message": {
"type": [
"string",
"null"
]
},
"notification_id": {
"format": "uuid",
"type": "string"
},
"origin_agent": {
"description": "Present when a connected agent originated the ping: its handle and display name.",
"type": "object"
},
"question": {},
"room": {
"type": "object"
},
"sender": {
"type": "object"
},
"state": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Withdraw a still-pending question you asked.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"question_id": {
"description": "Question id.",
"format": "uuid",
"type": "string"
}
},
"required": [
"question_id"
],
"type": "object"
},
"name": "cancel_question",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Verify the current connection: owner.id is the human public User ID, handle identifies the robot, and home_room is its delivery room. After login or reconnect, match owner.id and handle to the approved account and robot before sending. A mismatch means stop and reload or restart the MCP client. Includes a credential-protected latest-pings feed and token-free install URL; never send credentials to the install URL.",
"inputSchema": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"name": "connection_info",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"additionalProperties": true,
"description": "The authenticated robot and its owner public User ID, for account verification.",
"properties": {
"handle": {
"type": "string"
},
"owner": {
"additionalProperties": false,
"properties": {
"id": {
"description": "The human public User ID shown in PingRoom, not an internal database identifier.",
"pattern": "^[A-Z0-9]{12}$",
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"status": {
"enum": [
"active",
"revoked"
],
"type": "string"
}
},
"required": [
"status",
"handle",
"owner"
],
"type": "object"
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Hand work to exactly one human as either an acknowledgement or a tappable question. The server verifies that one of the recipient's current devices supports the complete Handoff action before creating anything.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"audience": {
"additionalProperties": false,
"properties": {
"type": {
"enum": [
"direct"
],
"type": "string"
},
"user_id": {
"description": "The authorizing human, expressed as the literal value \"me\".",
"enum": [
"me"
],
"type": "string"
}
},
"required": [
"type",
"user_id"
],
"type": "object"
},
"correlation_id": {
"description": "Your own stable correlation id.",
"maxLength": 255,
"type": "string"
},
"data": {
"description": "Structured context returned on read surfaces after connector privacy filtering. Do not put secrets in data.",
"type": "object"
},
"expires_in": {
"description": "Seconds before the handoff expires; the server clamps this to its safe range.",
"type": "integer"
},
"idempotency_key": {
"description": "Stable key for at-most-once creation across both Ack and Question kinds.",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"kind": {
"description": "ack asks the human to acknowledge; question asks them to choose an option.",
"enum": [
"ack",
"question"
],
"type": "string"
},
"options": {
"description": "Required for question and forbidden for ack. Each item may be a label string or a structured option.",
"items": {
"oneOf": [
{
"maxLength": 40,
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"label": {
"maxLength": 40,
"type": "string"
},
"style": {
"enum": [
"primary",
"danger",
"default"
],
"type": "string"
},
"value": {
"maxLength": 40,
"type": "string"
}
},
"required": [
"value",
"label"
],
"type": "object"
}
]
},
"maxItems": 4,
"minItems": 2,
"type": "array"
},
"prompt": {
"description": "The work/request shown to the human.",
"maxLength": 500,
"type": "string"
},
"reply_to": {
"description": "Optional routing pointer.",
"maxLength": 255,
"type": "string"
},
"urgency": {
"description": "Notification interruption level. Defaults to active.",
"enum": [
"active",
"passive"
],
"type": "string"
}
},
"required": [
"kind",
"prompt",
"audience"
],
"type": "object"
},
"name": "create_handoff",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Create a publicly discoverable room with a unique @handle. Counts toward the free-plan five-room cap.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"category": {
"description": "Discovery category.",
"maxLength": 100,
"type": "string"
},
"color": {
"description": "Hex color, e.g. \"#e33122\".",
"type": "string"
},
"description": {
"description": "Short room description shown in public discovery.",
"maxLength": 120,
"type": "string"
},
"handle": {
"description": "Globally unique @handle (vanity URL): lowercase letters, digits, underscores.",
"pattern": "^[a-z0-9_]{3,20}$",
"type": "string"
},
"icon": {
"description": "A v3 room-icon catalog id, e.g. \"bell\". Call list_room_icons to discover the valid ids.",
"type": "string"
},
"location_latitude": {
"description": "Latitude in decimal degrees. Send all three location fields or none.",
"maximum": 90,
"minimum": -90,
"type": "number"
},
"location_longitude": {
"description": "Longitude in decimal degrees. Send all three location fields or none.",
"maximum": 180,
"minimum": -180,
"type": "number"
},
"location_name": {
"description": "Place name shown in nearby discovery. Send all three location fields or none.",
"maxLength": 160,
"type": "string"
},
"name": {
"description": "Room display name.",
"maxLength": 24,
"type": "string"
},
"show_owner": {
"description": "Whether the owner is shown publicly. Defaults to true.",
"type": "boolean"
}
},
"required": [
"name",
"icon",
"color",
"handle"
],
"type": "object"
},
"name": "create_public_room",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Create a new private room owned by the authenticated account. Free accounts may own up to five rooms. If this agent was granted every room and has no delivery room yet, the new room becomes its delivery room — where its handoffs and direct questions land.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"color": {
"description": "Hex color, e.g. \"#e33122\".",
"type": "string"
},
"icon": {
"description": "A v3 room-icon catalog id, e.g. \"bell\". Call list_room_icons to discover the valid ids.",
"type": "string"
},
"name": {
"description": "Room display name.",
"maxLength": 24,
"type": "string"
}
},
"required": [
"name",
"icon",
"color"
],
"type": "object"
},
"name": "create_room",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Create an incoming webhook for a room the account owns. The bound account must be Pro. Returns the secret trigger URL — treat it as a credential.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"action_number": {
"description": "Quick-action slot whose label, sound, and acknowledgement preset fires use. Omit or pass null for an independent webhook with no Quick Ping preset.",
"maximum": 16,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"color": {
"description": "Hex color, e.g. \"#e33122\".",
"type": "string"
},
"cooldown_seconds": {
"description": "Minimum seconds between fires. Defaults to 5.",
"maximum": 60,
"minimum": 0,
"type": "integer"
},
"enabled": {
"description": "Whether the webhook is active. Defaults to true.",
"type": "boolean"
},
"icon": {
"description": "A v3 room-icon catalog id, e.g. \"bell\". Call list_room_icons to discover the valid ids.",
"type": "string"
},
"invite_code": {
"description": "Room invite code.",
"type": "string"
},
"message": {
"description": "Optional default push body (max 120 characters in private rooms, 160 in public rooms).",
"maxLength": 160,
"type": "string"
},
"name": {
"description": "Webhook name (shown to the owner).",
"maxLength": 100,
"type": "string"
},
"sound": {
"description": "Canonical sound id, e.g. \"ting\". Omit for the room default.",
"type": "string"
},
"title": {
"description": "Optional push title used when the webhook fires.",
"maxLength": 40,
"type": "string"
}
},
"required": [
"invite_code",
"name"
],
"type": "object"
},
"name": "create_webhook",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"additionalProperties": false,
"description": "An incoming webhook. `webhook_url` embeds the secret — treat it as a credential.",
"properties": {
"action_number": {
"type": [
"integer",
"null"
]
},
"color": {
"type": [
"string",
"null"
]
},
"cooldown_seconds": {
"type": [
"integer",
"null"
]
},
"enabled": {
"type": "boolean"
},
"icon": {
"type": [
"string",
"null"
]
},
"id": {
"format": "uuid",
"type": [
"string",
"null"
]
},
"message": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"sound": {
"type": [
"string",
"null"
]
},
"title": {
"type": [
"string",
"null"
]
},
"webhook_url": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Delete an attachment this agent uploaded that is not yet claimed by a ping.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"attachment_id": {
"description": "Attachment id returned by upload_attachment.",
"format": "uuid",
"type": "string"
}
},
"required": [
"attachment_id"
],
"type": "object"
},
"name": "delete_attachment",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Delete an incoming webhook (by id) from a room the account owns.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"invite_code": {
"description": "Room invite code.",
"type": "string"
},
"webhook_id": {
"description": "Webhook id (from list_webhooks or create_webhook).",
"type": "string"
}
},
"required": [
"invite_code",
"webhook_id"
],
"type": "object"
},
"name": "delete_webhook",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Revoke this authenticated robot connection, including its access and refresh credentials and room memberships. Use only when the human explicitly requests logout, disconnection, or reconnection. Call BEFORE clearing local credentials or running MCP logout/login. It affects only the current connection and accepts no account or robot selector. After login, restart or reload the MCP client, then match connection_info owner.id and handle to the approved account and robot before sending.",
"inputSchema": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"name": "disconnect",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"additionalProperties": true,
"description": "The authenticated robot and its owner public User ID, for account verification.",
"properties": {
"handle": {
"type": "string"
},
"owner": {
"additionalProperties": false,
"properties": {
"id": {
"description": "The human public User ID shown in PingRoom, not an internal database identifier.",
"pattern": "^[A-Z0-9]{12}$",
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"status": {
"enum": [
"active",
"revoked"
],
"type": "string"
}
},
"required": [
"status",
"handle",
"owner"
],
"type": "object"
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Fetch the current status of an approval request without blocking.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"approval_id": {
"description": "Approval request id.",
"format": "uuid",
"type": "string"
}
},
"required": [
"approval_id"
],
"type": "object"
},
"name": "get_approval",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Fetch an attachment visible to this agent as base64 content plus metadata. Results over the connector size limit return attachment_too_large — fetch those via the agent REST API instead.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"attachment_id": {
"description": "Attachment id returned by upload_attachment.",
"format": "uuid",
"type": "string"
}
},
"required": [
"attachment_id"
],
"type": "object"
},
"name": "get_attachment",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Fetch the authoritative current state of one Handoff without blocking.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"handoff_id": {
"description": "Handoff id.",
"format": "uuid",
"type": "string"
}
},
"required": [
"handoff_id"
],
"type": "object"
},
"name": "get_handoff",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Read back the current state of a live stream you created, so a restarted producer can reconcile instead of starting a duplicate. Only returns streams started by this credential, within the last 24 hours. Returns notification_id and correlation_id, then the stored display state (state, progress, message, category, template, accent_override, eta_at, deadline_at, duration_seconds, metrics, prompt, options, left, right, center, steps, current_step), action_state, and updated_at. Fields you never set come back as null rather than being omitted, so a matchup/metrics/countdown/question stream can be resumed without re-sending content.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "The stream key used when the stream was started.",
"maxLength": 255,
"type": "string"
},
"invite_code": {
"description": "Room invite code.",
"type": "string"
}
},
"required": [
"invite_code",
"correlation_id"
],
"type": "object"
},
"name": "get_live_status",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Fetch one visible ping by notification id, including its current action_state.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"notification_id": {
"description": "Room notification id.",
"format": "uuid",
"type": "string"
}
},
"required": [
"notification_id"
],
"type": "object"
},
"name": "get_notification",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"additionalProperties": true,
"description": "A privacy-minimized, chainable PingRoom notification result.",
"properties": {
"action_state": {
"type": "object"
},
"attachments": {
"type": "array"
},
"correlation_id": {
"type": [
"string",
"null"
]
},
"data": {
"additionalProperties": true,
"description": "Structured context after connector privacy filtering. Credential, account, and direct-contact fields are removed.",
"maxProperties": 25,
"type": "object"
},
"delivery_state": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"message": {
"type": [
"string",
"null"
]
},
"notification_id": {
"format": "uuid",
"type": "string"
},
"origin_agent": {
"description": "Present when a connected agent originated the ping: its handle and display name.",
"type": "object"
},
"question": {},
"room": {
"type": "object"
},
"sender": {
"type": "object"
},
"state": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Fetch the current state of a question without blocking.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"question_id": {
"description": "Question id.",
"format": "uuid",
"type": "string"
}
},
"required": [
"question_id"
],
"type": "object"
},
"name": "get_question",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Fetch a single room by its invite code, including members and quick actions.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"invite_code": {
"description": "Room invite code.",
"type": "string"
}
},
"required": [
"invite_code"
],
"type": "object"
},
"name": "get_room",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Join a room using its invite code. Include the password only if the room is protected.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"invite_code": {
"description": "Room invite code.",
"type": "string"
},
"password": {
"description": "Only required for password-protected rooms.",
"type": "string"
}
},
"required": [
"invite_code"
],
"type": "object"
},
"name": "join_room",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "List a bounded page of this agent's Handoffs, newest first. Omit state (or use open) for unresolved work; use all for history and page while has_more is true.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"limit": {
"default": 10,
"description": "Handoffs per page. Defaults to 10; maximum 25.",
"maximum": 25,
"minimum": 1,
"type": "integer"
},
"page": {
"description": "Page number, newest first.",
"minimum": 1,
"type": "integer"
},
"state": {
"description": "Filter to open Handoffs or include all states.",
"enum": [
"open",
"all"
],
"type": "string"
}
},
"type": "object"
},
"name": "list_handoffs",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"additionalProperties": false,
"properties": {
"handoffs": {
"items": {
"type": "object"
},
"type": "array"
},
"has_more": {
"type": "boolean"
},
"page": {
"type": "integer"
},
"per_page": {
"type": "integer"
}
},
"required": [
"handoffs",
"page",
"per_page",
"has_more"
],
"type": "object"
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "List a bounded page of recent pings across approved rooms, newest first. Use page to continue while has_more is true.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"date": {
"description": "Only pings created on this calendar date, e.g. \"2026-08-25\".",
"format": "date",
"type": "string"
},
"limit": {
"default": 10,
"description": "Pings per page. Defaults to 10; maximum 25.",
"maximum": 25,
"minimum": 1,
"type": "integer"
},
"page": {
"description": "Page number, newest first.",
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Narrow to pings you received or pings you sent. Omit for both.",
"enum": [
"received",
"sent"
],
"type": "string"
}
},
"type": "object"
},
"name": "list_notifications",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"additionalProperties": false,
"properties": {
"has_more": {
"type": "boolean"
},
"last_page": {
"type": [
"integer",
"null"
]
},
"notifications": {
"items": {
"additionalProperties": true,
"description": "A privacy-minimized, chainable PingRoom notification result.",
"properties": {
"action_state": {
"type": "object"
},
"attachments": {
"type": "array"
},
"correlation_id": {
"type": [
"string",
"null"
]
},
"data": {
"additionalProperties": true,
"description": "Structured context after connector privacy filtering. Credential, account, and direct-contact fields are removed.",
"maxProperties": 25,
"type": "object"
},
"delivery_state": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"message": {
"type": [
"string",
"null"
]
},
"notification_id": {
"format": "uuid",
"type": "string"
},
"origin_agent": {
"description": "Present when a connected agent originated the ping: its handle and display name.",
"type": "object"
},
"question": {},
"room": {
"type": "object"
},
"sender": {
"type": "object"
},
"state": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"page": {
"type": [
"integer",
"null"
]
},
"per_page": {
"type": [
"integer",
"null"
]
},
"total": {
"type": [
"integer",
"null"
]
}
},
"type": "object"
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "List a bounded page of questions you asked, newest first. Optionally filter by state; use page while has_more is true.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"limit": {
"default": 10,
"description": "Questions per page. Defaults to 10; maximum 25.",
"maximum": 25,
"minimum": 1,
"type": "integer"
},
"page": {
"description": "Page number, newest first.",
"minimum": 1,
"type": "integer"
},
"state": {
"description": "Filter by state. Omit for all.",
"enum": [
"pending",
"answered",
"expired",
"cancelled",
"all"
],
"type": "string"
}
},
"type": "object"
},
"name": "list_questions",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"additionalProperties": false,
"properties": {
"has_more": {
"type": "boolean"
},
"page": {
"type": "integer"
},
"per_page": {
"type": "integer"
},
"questions": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"questions",
"page",
"per_page",
"has_more"
],
"type": "object"
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "List the quick actions configured for a room.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"invite_code": {
"description": "Room invite code.",
"type": "string"
}
},
"required": [
"invite_code"
],
"type": "object"
},
"name": "list_quick_actions",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"items": {
"additionalProperties": false,
"properties": {
"action_number": {
"type": [
"integer",
"null"
]
},
"icon": {
"type": [
"string",
"null"
]
},
"input_type": {
"enum": [
"none",
"location",
"link",
"file",
"photo",
"pdf"
],
"type": "string"
},
"label": {
"type": [
"string",
"null"
]
},
"requires_ack": {
"type": "boolean"
}
},
"type": "object"
},
"type": "array"
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "List the room-icon catalog (icon ids, tags, and categories). Call this before create_room / create_public_room / create_webhook to pick a valid icon id, and to interpret icon values returned by reads.",
"inputSchema": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"name": "list_room_icons",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "List the rooms the authenticated account belongs to.",
"inputSchema": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"name": "list_rooms",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"items": {
"additionalProperties": false,
"properties": {
"color": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"icon": {
"type": [
"string",
"null"
]
},
"invite_code": {
"type": [
"string",
"null"
]
},
"is_public": {
"type": "boolean"
},
"muted": {
"type": "boolean"
},
"name": {
"type": [
"string",
"null"
]
},
"paused": {
"type": "boolean"
},
"quick_action_count": {
"maximum": 16,
"minimum": 0,
"type": "integer"
},
"quick_action_limit": {
"enum": [
4,
16
],
"type": "integer"
},
"quick_actions": {
"items": {
"additionalProperties": false,
"properties": {
"action_number": {
"type": [
"integer",
"null"
]
},
"icon": {
"type": [
"string",
"null"
]
},
"input_type": {
"enum": [
"none",
"location",
"link",
"file",
"photo",
"pdf"
],
"type": "string"
},
"label": {
"type": [
"string",
"null"
]
},
"requires_ack": {
"type": "boolean"
}
},
"type": "object"
},
"type": "array"
},
"type": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": "array"
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "List the incoming webhooks (with their trigger URLs) for a room the account owns.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"invite_code": {
"description": "Room invite code.",
"type": "string"
}
},
"required": [
"invite_code"
],
"type": "object"
},
"name": "list_webhooks",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"items": {
"additionalProperties": false,
"description": "An incoming webhook. `webhook_url` embeds the secret — treat it as a credential.",
"properties": {
"action_number": {
"type": [
"integer",
"null"
]
},
"color": {
"type": [
"string",
"null"
]
},
"cooldown_seconds": {
"type": [
"integer",
"null"
]
},
"enabled": {
"type": "boolean"
},
"icon": {
"type": [
"string",
"null"
]
},
"id": {
"format": "uuid",
"type": [
"string",
"null"
]
},
"message": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"sound": {
"type": [
"string",
"null"
]
},
"title": {
"type": [
"string",
"null"
]
},
"webhook_url": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": "array"
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Start, update, or end a live progress card on the room members' lock screen (an iOS Live Activity / Android live update). Reuse the same correlation_id for every ping of one stream: the first ping starts the card and sends one alert, further \"running\" pings move it silently, and the first \"done\"/\"failed\" sends one completion alert and ends it. Free accounts get a small number of NEW streams per day; updates and the final ping of an open stream are never charged; a first ping that is already \"done\"/\"failed\" counts as a new stream.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"ack_timeout_seconds": {
"description": "Optional acknowledgement deadline in seconds.",
"maximum": 86400,
"minimum": 1,
"type": "integer"
},
"action": {
"description": "Quick-action slot to attribute the stream to (supplies the icon and sound).",
"maximum": 16,
"minimum": 1,
"type": "integer"
},
"correlation_id": {
"description": "The stream key. Reuse it on every ping of the same stream.",
"maxLength": 255,
"type": "string"
},
"data": {
"description": "Arbitrary structured context (max 25 keys / 8KB), returned on read surfaces after connector privacy filtering. Do not put secrets in data.",
"type": "object"
},
"invite_code": {
"description": "Room invite code.",
"type": "string"
},
"live_status": {
"additionalProperties": false,
"description": "The live card's state. Only state is required.",
"properties": {
"accent_override": {
"description": "Hex #rrggbb; a semantic accent for one frame (e.g. deadline red).",
"type": "string"
},
"category": {
"description": "Legacy rendering category; prefer template. \"alert\" has NO template equivalent and is the only way to start a stream time-sensitive (breaks through Focus). Fixed at stream creation.",
"enum": [
"status",
"steps",
"alert"
],
"type": "string"
},
"center": {
"description": "Center score/clock for the matchup template.",
"maxLength": 40,
"type": "string"
},
"current_step": {
"description": "Index into steps; the only mutable steps field.",
"maximum": 8,
"minimum": 0,
"type": "integer"
},
"deadline_at": {
"description": "Epoch seconds the countdown template counts down to.",
"type": "integer"
},
"duration_seconds": {
"description": "Original countdown duration in seconds. Set on creation; preserved through updates and completion.",
"maximum": 4102444800,
"minimum": 1,
"type": "integer"
},
"eta_at": {
"description": "Epoch seconds; renders a live ETA on status/progress.",
"type": "integer"
},
"left": {
"additionalProperties": false,
"description": "Left side {label,value} for the matchup template.",
"properties": {
"label": {
"maxLength": 24,
"type": "string"
},
"value": {
"maxLength": 24,
"type": "string"
}
},
"required": [
"label",
"value"
],
"type": "object"
},
"message": {
"description": "The card's live message line.",
"maxLength": 256,
"type": "string"
},
"metrics": {
"description": "Up to 3 {label,value} counters for the metrics template.",
"items": {
"additionalProperties": false,
"properties": {
"label": {
"maxLength": 24,
"type": "string"
},
"value": {
"maxLength": 24,
"type": "string"
}
},
"required": [
"label",
"value"
],
"type": "object"
},
"maxItems": 3,
"type": "array"
},
"options": {
"description": "Up to 4 {value,label} choices for the question template.",
"items": {
"additionalProperties": false,
"properties": {
"label": {
"maxLength": 40,
"type": "string"
},
"value": {
"maxLength": 64,
"type": "string"
}
},
"required": [
"value",
"label"
],
"type": "object"
},
"maxItems": 4,
"type": "array"
},
"progress": {
"description": "Progress bar / Dynamic Island gauge, 0..1.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"prompt": {
"description": "The ask, for the question template.",
"maxLength": 256,
"type": "string"
},
"right": {
"additionalProperties": false,
"description": "Right side {label,value} for the matchup template.",
"properties": {
"label": {
"maxLength": 24,
"type": "string"
},
"value": {
"maxLength": 24,
"type": "string"
}
},
"required": [
"label",
"value"
],
"type": "object"
},
"state": {
"description": "running keeps the card live; done/failed end it with one completion alert.",
"enum": [
"running",
"done",
"failed"
],
"type": "string"
},
"steps": {
"description": "Step labels. Required on the first ping of a steps stream; immutable afterwards.",
"items": {
"maxLength": 40,
"type": "string"
},
"maxItems": 8,
"minItems": 2,
"type": "array"
},
"template": {
"description": "Which layout the OS renders. Fixed at stream creation.",
"enum": [
"status",
"steps",
"progress",
"metrics",
"countdown",
"question",
"matchup"
],
"type": "string"
}
},
"required": [
"state"
],
"type": "object"
},
"requires_ack": {
"description": "Add an Acknowledge button; the first eligible member to tap resolves it for everyone. Does not raise the interruption level — set category \"alert\" for a time-sensitive start.",
"type": "boolean"
},
"title": {
"description": "Card title. Defaults to the selected quick action's label.",
"maxLength": 40,
"type": "string"
}
},
"required": [
"invite_code",
"correlation_id",
"live_status"
],
"type": "object"
},
"name": "live_status",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Redeem a gifted Pro or promo code for the human account that connected this agent. Consumes a single-use code and grants Pro; no room or paid plan is required. Use only a code the user supplied for redemption. Existing eligibility and one-per-account limits apply. Do not retry a successful redemption.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"code": {
"description": "The 12-letter/digit gift or promo code. Case-insensitive; surrounding whitespace is trimmed.",
"pattern": "^[ \\t\\r\\n]*[A-Za-z0-9]{12}[ \\t\\r\\n]*$",
"type": "string"
}
},
"required": [
"code"
],
"type": "object"
},
"name": "redeem_code",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"additionalProperties": false,
"properties": {
"kind": {
"enum": [
"gift",
"redeem"
],
"type": "string"
},
"lifetime": {
"type": "boolean"
},
"message": {
"type": "string"
},
"package": {
"enum": [
"monthly",
"yearly",
"lifetime",
null
],
"type": [
"string",
"null"
]
},
"plan": {
"enum": [
"pro"
],
"type": "string"
},
"plan_expires_at": {
"type": [
"string",
"null"
]
},
"reward_days": {
"type": [
"integer",
"null"
]
}
},
"required": [
"message",
"kind",
"reward_days",
"package",
"lifetime",
"plan",
"plan_expires_at"
],
"type": "object"
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Ask the human to approve or reject an action, then block on their answer (pair with wait_for_approval). Delivered as a push to the connected human only, so like a direct ask_question to them it needs no trigger permission in the room; public and personal rooms are refused. Rate-limited.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "Your own id, echoed back unchanged on read.",
"maxLength": 255,
"type": "string"
},
"data": {
"description": "Arbitrary structured context, returned on reads after connector privacy filtering. Do not put secrets in data.",
"type": "object"
},
"idempotency_key": {
"description": "Stable key so a retried call cannot create a second one.",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"invite_code": {
"description": "Room invite code.",
"type": "string"
},
"options": {
"description": "Answers to choose between. Defaults to [\"approve\",\"deny\"].",
"items": {
"maxLength": 40,
"type": "string"
},
"maxItems": 4,
"minItems": 2,
"type": "array"
},
"question": {
"description": "What you want the human to decide on.",
"maxLength": 500,
"type": "string"
},
"title": {
"description": "Optional short title for the request.",
"maxLength": 40,
"type": "string"
},
"ttl": {
"description": "Seconds the request stays open before it expires.",
"minimum": 1,
"type": "integer"
}
},
"required": [
"invite_code",
"question"
],
"type": "object"
},
"name": "request_approval",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Rotate this agent's public handle — kill-switch for a leaked handle.",
"inputSchema": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"name": "rotate_handle",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Set this agent's avatar. Must be one of the PingRoom bot avatars.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"avatar_id": {
"description": "Bot avatar id, e.g. \"bots-3\".",
"type": "string"
}
},
"required": [
"avatar_id"
],
"type": "object"
},
"name": "set_avatar",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Press a room quick action, notifying its members. Rate-limited. Read the action's input_type first (list_quick_actions): location needs data.location, link needs data.url, file/photo/pdf need attachment_ids — a press without the matching detail is a 422 quick_action_input_required.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"ack_mode": {
"description": "Confirmation rule for this press: any (default) resolves on the first confirmation; all waits for every original eligible recipient. Applies only when this press requires acknowledgement.",
"enum": [
"any",
"all"
],
"type": "string"
},
"action_number": {
"description": "Quick-action slot number (1–16). Slots 5–16 require the room owner to have Pro.",
"maximum": 16,
"minimum": 1,
"type": "integer"
},
"attachment_ids": {
"description": "Ids of up to 4 uploaded attachments (see upload_attachment). Required when the action's input_type is file, photo (jpg/png only) or pdf (pdf only); a mismatched type is a 422 quick_action_input_type.",
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 4,
"type": "array"
},
"data": {
"additionalProperties": false,
"description": "The detail this press carries. data.location satisfies an action whose input_type is location; data.url satisfies link. Only these two keys are accepted on a trigger.",
"properties": {
"location": {
"additionalProperties": false,
"description": "A shareable geographic location.",
"properties": {
"address": {
"description": "Optional formatted street address.",
"maxLength": 255,
"type": "string"
},
"label": {
"description": "Optional place name shown to the recipient.",
"maxLength": 100,
"type": "string"
},
"latitude": {
"description": "Latitude in decimal degrees.",
"maximum": 90,
"minimum": -90,
"type": "number"
},
"longitude": {
"description": "Longitude in decimal degrees.",
"maximum": 180,
"minimum": -180,
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object"
},
"url": {
"description": "An absolute http:// or https:// URL.",
"format": "uri",
"maxLength": 2048,
"type": "string"
}
},
"type": "object"
},
"invite_code": {
"description": "Room invite code.",
"type": "string"
},
"is_urgent": {
"description": "Deliver this one press time-sensitive so it breaks through Focus / Do Not Disturb and reaches members who muted the room or you (a block still wins). Send-time only — the action's saved configuration is unchanged.",
"type": "boolean"
},
"quick_action_id": {
"description": "Optional id of the action as read from list_quick_actions. When the slot has since moved pages the press is refused with 409 quick_action_layout_changed instead of firing the wrong Ping.",
"format": "uuid",
"type": "string"
},
"requires_ack": {
"description": "Keep this one press open until an eligible recipient acknowledges it. Send-time only and elevating only: true adds the acknowledgement to an action that has none, false never disables the action's stored ack policy.",
"type": "boolean"
},
"trigger_source": {
"description": "Defaults to \"manual\". Only these two are client-settable — \"webhook\" and \"system\" are stamped server-side and are rejected here.",
"enum": [
"manual",
"location"
],
"type": "string"
}
},
"required": [
"invite_code",
"action_number"
],
"type": "object"
},
"name": "trigger_quick_action",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"additionalProperties": true,
"description": "A privacy-minimized, chainable PingRoom notification result.",
"properties": {
"action_state": {
"type": "object"
},
"attachments": {
"type": "array"
},
"correlation_id": {
"type": [
"string",
"null"
]
},
"data": {
"additionalProperties": true,
"description": "Structured context after connector privacy filtering. Credential, account, and direct-contact fields are removed.",
"maxProperties": 25,
"type": "object"
},
"delivery_state": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"message": {
"type": [
"string",
"null"
]
},
"notification_id": {
"format": "uuid",
"type": "string"
},
"origin_agent": {
"description": "Present when a connected agent originated the ping: its handle and display name.",
"type": "object"
},
"question": {},
"room": {
"type": "object"
},
"sender": {
"type": "object"
},
"state": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Configure a numbered quick-action slot for a room the account owns. Sends a background room refresh to room members' devices.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"action_number": {
"description": "Quick-action slot number (1–16). Slots 5–16 require the room owner to have Pro.",
"maximum": 16,
"minimum": 1,
"type": "integer"
},
"icon": {
"description": "Emoji or icon id.",
"type": "string"
},
"input_type": {
"description": "Detail every press of this action must carry: none (default), location (data.location), link (data.url), file (any attachment), photo (jpg/png attachment) or pdf (pdf attachment). A press without it is a 422 quick_action_input_required.",
"enum": [
"none",
"location",
"link",
"file",
"photo",
"pdf"
],
"type": "string"
},
"invite_code": {
"description": "Room invite code.",
"type": "string"
},
"label": {
"description": "Button label. Must be sent, but may be empty (\"\") — a Ping can be named by its emoji alone, and clients render an untitled one as just the emoji.",
"maxLength": 255,
"type": "string"
},
"requires_ack": {
"description": "Whether pings from this action remain open until one eligible recipient acknowledges them.",
"type": "boolean"
},
"sound": {
"description": "Canonical sound id, e.g. \"ting\". Omit for the room default.",
"type": "string"
}
},
"required": [
"invite_code",
"action_number",
"label",
"icon"
],
"type": "object"
},
"name": "update_quick_action",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Configure several of a room's quick-action slots in one call. Prefer this over repeated update_quick_action: each single-slot write wakes room members' devices with its own background refresh, so setting up four Pings one at a time spends four of a finite daily push budget on one operation. Slots you do not list are left exactly as they are, so this is also the right tool for editing a single Ping.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"actions": {
"description": "Add new pages as complete groups of four in order (5–8, 9–12, 13–16); the room owner needs Pro. The slots to write. Each action_number must appear at most once. Slots omitted here keep their current configuration — nothing in this tool deletes an action.",
"items": {
"additionalProperties": false,
"properties": {
"action_number": {
"description": "Quick-action slot number (1–16). Slots 5–16 require the room owner to have Pro.",
"maximum": 16,
"minimum": 1,
"type": "integer"
},
"icon": {
"description": "Emoji or icon id.",
"type": "string"
},
"input_type": {
"description": "Detail every press of this action must carry: none (default), location (data.location), link (data.url), file (any attachment), photo (jpg/png attachment) or pdf (pdf attachment). A press without it is a 422 quick_action_input_required.",
"enum": [
"none",
"location",
"link",
"file",
"photo",
"pdf"
],
"type": "string"
},
"label": {
"description": "Button label. Must be sent, but may be empty (\"\") — a Ping can be named by its emoji alone, and clients render an untitled one as just the emoji.",
"maxLength": 255,
"type": "string"
},
"requires_ack": {
"description": "Whether pings from this action remain open until one eligible recipient acknowledges them.",
"type": "boolean"
},
"sound": {
"description": "Canonical sound id, e.g. \"ting\". Omit for the room default.",
"type": "string"
}
},
"required": [
"action_number",
"label",
"icon"
],
"type": "object"
},
"maxItems": 16,
"minItems": 1,
"type": "array"
},
"invite_code": {
"description": "Room invite code.",
"type": "string"
}
},
"required": [
"invite_code",
"actions"
],
"type": "object"
},
"name": "update_quick_actions",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Update an incoming webhook (by id) on a room the account owns — e.g. change its icon, title, message, or sound.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"action_number": {
"description": "Quick-action slot whose label, sound, and acknowledgement preset fires use. Pass null to clear the preset and make the webhook independent.",
"maximum": 16,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"color": {
"description": "Hex color, e.g. \"#e33122\".",
"type": "string"
},
"cooldown_seconds": {
"description": "Minimum seconds between fires.",
"maximum": 60,
"minimum": 0,
"type": "integer"
},
"enabled": {
"description": "Whether the webhook is active.",
"type": "boolean"
},
"icon": {
"description": "A v3 room-icon catalog id, e.g. \"bell\". Call list_room_icons to discover the valid ids.",
"type": "string"
},
"invite_code": {
"description": "Room invite code.",
"type": "string"
},
"message": {
"description": "Default push body (max 120 characters in private rooms, 160 in public rooms).",
"maxLength": 160,
"type": "string"
},
"name": {
"description": "Webhook name (shown to the owner).",
"maxLength": 100,
"type": "string"
},
"regenerate_secret": {
"description": "Rotate the secret trigger URL.",
"type": "boolean"
},
"sound": {
"description": "Canonical sound id, e.g. \"ting\".",
"type": "string"
},
"title": {
"description": "Push title used when the webhook fires.",
"maxLength": 40,
"type": "string"
},
"webhook_id": {
"description": "Webhook id (from list_webhooks or create_webhook).",
"type": "string"
}
},
"required": [
"invite_code",
"webhook_id"
],
"type": "object"
},
"name": "update_webhook",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"additionalProperties": false,
"description": "An incoming webhook. `webhook_url` embeds the secret — treat it as a credential.",
"properties": {
"action_number": {
"type": [
"integer",
"null"
]
},
"color": {
"type": [
"string",
"null"
]
},
"cooldown_seconds": {
"type": [
"integer",
"null"
]
},
"enabled": {
"type": "boolean"
},
"icon": {
"type": [
"string",
"null"
]
},
"id": {
"format": "uuid",
"type": [
"string",
"null"
]
},
"message": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"sound": {
"type": [
"string",
"null"
]
},
"title": {
"type": [
"string",
"null"
]
},
"webhook_url": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Upload a small file (max ~90 KiB over MCP; Pro account required) and get an attachment id to include in broadcast or ask_question via attachment_ids. Larger files: use the PingRoom CLI or agent REST API.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"content_base64": {
"description": "Base64-encoded file bytes (standard alphabet, padding optional).",
"maxLength": 124000,
"minLength": 1,
"type": "string"
},
"filename": {
"description": "File name including extension, e.g. report.md.",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"mime_type": {
"description": "Optional MIME type, e.g. text/markdown. Defaults from the filename extension.",
"maxLength": 100,
"type": "string"
}
},
"required": [
"filename",
"content_base64"
],
"type": "object"
},
"name": "upload_attachment",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Long-poll a generic acknowledgement-required ping until its confirmation rule is met (any: first confirmation; all: every original eligible recipient), it expires, or the timeout elapses. Questions use wait_for_answer instead.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"notification_id": {
"description": "Room notification id.",
"format": "uuid",
"type": "string"
},
"timeout": {
"description": "Seconds to hold the request open. Use 0 for an immediate authoritative state read.",
"maximum": 30,
"minimum": 0,
"type": "integer"
}
},
"required": [
"notification_id"
],
"type": "object"
},
"name": "wait_for_ack",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"additionalProperties": true,
"description": "A privacy-minimized, chainable PingRoom notification result.",
"properties": {
"action_state": {
"type": "object"
},
"attachments": {
"type": "array"
},
"correlation_id": {
"type": [
"string",
"null"
]
},
"data": {
"additionalProperties": true,
"description": "Structured context after connector privacy filtering. Credential, account, and direct-contact fields are removed.",
"maxProperties": 25,
"type": "object"
},
"delivery_state": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"message": {
"type": [
"string",
"null"
]
},
"notification_id": {
"format": "uuid",
"type": "string"
},
"origin_agent": {
"description": "Present when a connected agent originated the ping: its handle and display name.",
"type": "object"
},
"question": {},
"room": {
"type": "object"
},
"sender": {
"type": "object"
},
"state": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Long-poll a question until it is answered or expires. Returns the state and, once answered, the chosen option value + label and the responder.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"question_id": {
"description": "Question id.",
"format": "uuid",
"type": "string"
},
"timeout": {
"description": "Seconds to hold the request open (server-capped).",
"maximum": 30,
"minimum": 1,
"type": "integer"
}
},
"required": [
"question_id"
],
"type": "object"
},
"name": "wait_for_answer",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Long-poll an approval request until the human decides or it expires. Returns the status and, once decided, the chosen option.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"approval_id": {
"description": "Approval request id.",
"format": "uuid",
"type": "string"
},
"timeout": {
"description": "Seconds to hold the request open (server-capped).",
"maximum": 30,
"minimum": 1,
"type": "integer"
}
},
"required": [
"approval_id"
],
"type": "object"
},
"name": "wait_for_approval",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Long-poll a Handoff until the human resolves it, it expires, or the bounded timeout elapses. For the onboarding Question returned by activate_agent_inbox, success requires an answered result with activation_completed true; use a bounded local deadline and treat any terminal answer without that stamp as incomplete.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"handoff_id": {
"description": "Handoff id.",
"format": "uuid",
"type": "string"
},
"timeout": {
"description": "Seconds to hold the request open; use 0 for an immediate state read.",
"maximum": 25,
"minimum": 0,
"type": "integer"
}
},
"required": [
"handoff_id"
],
"type": "object"
},
"name": "wait_for_handoff",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"description": "Purpose-built PingRoom result with credential and account fields removed."
}
},
"required": [
"result"
],
"type": "object"
}
},
{
"description": "Long-poll for the next ping. Blocks until one arrives or the timeout elapses — the real-time inbound channel for an agent. The agent's own sends are excluded.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Cursor from the previous call; omit to get the current head.",
"format": "uuid",
"type": "string"
},
"timeout": {
"description": "Seconds to hold the request open (server-capped).",
"maximum": 30,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"name": "wait_for_notification",
"outputSchema": {
"additionalProperties": false,
"properties": {
"result": {
"additionalProperties": false,
"properties": {
"cursor": {
"format": "uuid",
"type": [
"string",
"null"
]
},
"notifications": {
"items": {
"additionalProperties": true,
"description": "A privacy-minimized, chainable PingRoom notification result.",
"properties": {
"action_state": {
"type": "object"
},
"attachments": {
"type": "array"
},
"correlation_id": {
"type": [
"string",
"null"
]
},
"data": {
"additionalProperties": true,
"description": "Structured context after connector privacy filtering. Credential, account, and direct-contact fields are removed.",
"maxProperties": 25,
"type": "object"
},
"delivery_state": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"message": {
"type": [
"string",
"null"
]
},
"notification_id": {
"format": "uuid",
"type": "string"
},
"origin_agent": {
"description": "Present when a connected agent originated the ping: its handle and display name.",
"type": "object"
},
"question": {},
"room": {
"type": "object"
},
"sender": {
"type": "object"
},
"state": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"required": [
"result"
],
"type": "object"
}
}
]
}Verify it yourself
curl -s https://api.teppi.xyz/v1/evidence/sha256:79e44b00dfffd61bb36ffcc0dbf22f4dc5ad6352f73dc56128971f96d92391ee | sha256sum