Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.paubox.com/llms.txt

Use this file to discover all available pages before exploring further.

The Paubox MCP Server exposes five tools. Each tool maps to an underlying Paubox API operation and is available to any connected MCP client.

​
send_secure_email

Sends a single HIPAA-compliant email through the Paubox Email API. The sender address must belong to a domain you have verified in the Paubox dashboard.
ParameterTypeRequiredDescription
recipientsarray of stringsYesRecipient email addresses. Accepts plain addresses or "Name <email>" format.
fromstringYesSender address. Must be on a verified Paubox domain.
subjectstringYesEmail subject line.
text_bodystringNoPlain-text message body.
html_bodystringNoHTML message body.
bccarray of stringsNoBCC recipients.
reply_tostringNoReply-To address.
Example payload 
{
  "recipients": ["patient@example.com"],
  "from": "provider@clinic.com",
  "subject": "Your appointment summary",
  "text_body": "Thank you for visiting us today.",
  "html_body": "<p>Thank you for visiting us today.</p>"
}
Response — returns a source_tracking_id string you can pass to check_email_status.

​
check_email_status

Retrieves the current delivery status of a message sent via send_secure_email.
ParameterTypeRequiredDescription
source_tracking_idstringYesThe tracking ID returned by send_secure_email.
Example payload 
{
  "source_tracking_id": "abc123def456"
}
Response — returns an object with delivery_status (e.g., delivered, opened, failed) and a timestamp.

​
validate_credentials

Verifies that the API key configured in the MCP server is valid and has the expected permissions. Takes no parameters. Example payload 
{}
Response — returns { "valid": true } on success, or an error with a description if the key is missing or invalid.

​
get_form

Retrieves the full definition of a Paubox Form — including its title, description, and field schema — so an agent can present the form questions in a conversation. No authentication is required for this tool.
ParameterTypeRequiredDescription
form_idstring (UUID)YesUUID of the Paubox Form to retrieve.
Example payload 
{
  "form_id": "550e8400-e29b-41d4-a716-446655440000"
}
Response — returns a form object including title, description, form_json (field definitions), and metadata fields.

​
submit_form

Submits a completed response to a Paubox Form. No authentication is required for this tool.
ParameterTypeRequiredDescription
form_idstring (UUID)YesUUID of the form being submitted.
form_dataobjectYesKey-value pairs matching the form’s field schema (form_json). Structure varies per form.
attachmentsarray of objectsNoFile attachments. Each object must include name (filename) and content (base64-encoded file). Max total size: 250 MB.
Example payload — text fields only 
{
  "form_id": "550e8400-e29b-41d4-a716-446655440000",
  "form_data": {
    "first_name": "Jane",
    "last_name": "Smith",
    "email": "jane@example.com"
  }
}
Example payload — with attachment 
{
  "form_id": "550e8400-e29b-41d4-a716-446655440000",
  "form_data": {
    "first_name": "Jane"
  },
  "attachments": [
    {
      "name": "consent.pdf",
      "content": "JVBERi0xLjQ..."
    }
  ]
}
Response — returns HTTP 201 with no body on success.