# Spondyr — how to use (mcp.ai)

Connect your Spondyr account and use 21 tools for documents straight from your AI agent. Connect with your own API key. Spondyr is a correspondence template management and distribution platform that enables developers to quickly integrate template-driven content delivery via API, supporting email, SMS, fax, and postal mail.

## Option A — via MCP (recommended)
Remote MCP endpoint (HTTP, streamable): `https://api.mcp.ai/p_spondyr?ms=1787296020000`
Add it as a custom/remote MCP connector in your client (Claude, Cursor, VS Code…), then authenticate when prompted. Once connected, ask the agent to use the server's tools (e.g. `spondyr_conditions_list`).

## Option B — via direct REST API
Base URL: `https://api.mcp.ai/api/spondyr`
Auth: `Authorization: Bearer sk_live_…` — create a workspace API key at https://mcp.ai/settings/api-keys
Discover endpoints: `GET https://api.mcp.ai/api/spondyr/_endpoints`

### Endpoints
- `POST https://api.mcp.ai/api/spondyr/conditions/list` — Tool to list all conditions for a transaction type. Use when you need to discover existing condition rules before creating templates or generating correspondence. Conditions define criteria for select
  - body: { TransactionType: string }
- `POST https://api.mcp.ai/api/spondyr/create/condition` — Create a condition rule for template selection in Spondyr. Conditions define matching criteria on transaction data fields that determine which document template to use. For example, create a condition
  - body: { Name: string, FieldName: string, PossibleValues?: string, TransactionType: string }
- `POST https://api.mcp.ai/api/spondyr/create/transaction/type` — Tool to create a new transaction type. Use after defining the JSON schema for your data to register it in Spondyr.
  - body: { Name: string, TemplateJSON: string }
- `POST https://api.mcp.ai/api/spondyr/deliver/spondyr` — Trigger delivery of previously generated correspondence to recipients. Use this action after generating correspondence (via POST /Spondyr with IsGenerateOnly=true) to actually deliver the documents vi
  - body: { Template?: string, ReferenceID: string, NewRecipients?: object[], OriginalRecipients?: string }
- `POST https://api.mcp.ai/api/spondyr/event/type/update` — Tool to update an existing event type name within a transaction type. Use when you need to rename an Event Type. Example: Rename the 'OrderShipped' event to 'OrderDelivered' within the 'CustomerOrders
  - body: { Name: string, EventType: string, TransactionType: string }
- `POST https://api.mcp.ai/api/spondyr/get/event/types` — Retrieves all event types associated with a specific transaction type in Spondyr. Event types define the kinds of events that can occur for a transaction type (e.g., "Created", "Updated", "Cancelled" 
  - body: { TransactionType: string }
- `POST https://api.mcp.ai/api/spondyr/get/spondyr/status` — Tool to retrieve the status of a previously generated correspondence. Use after generating correspondence to check its processing and delivery status.
  - body: { LastName?: string, FirstName?: string, IncludeData?: boolean, ReferenceID: string, ApplicationUserID?: string }
- `POST https://api.mcp.ai/api/spondyr/get/transaction/types` — Tool to retrieve a list of available transaction types. Use after authentication to discover data schemas.
- `POST https://api.mcp.ai/api/spondyr/recipient/delete` — Deletes a recipient configuration from a transaction type in Spondyr. Recipients are configured delivery endpoints (email addresses, fax numbers, physical addresses) that determine where correspondenc
  - body: { Recipient: string, TransactionType: string }
- `POST https://api.mcp.ai/api/spondyr/recipient/get` — Tool to retrieve details of a specific recipient. Use when you need to fetch recipient configuration for a given transaction type. Example: "Retrieve recipient 'Customer' for transaction type 'OrderPl
  - body: { Recipient: string, TransactionType: string }
- `POST https://api.mcp.ai/api/spondyr/recipients/list` — Tool to list all recipients for a transaction type. Use when you need to discover or verify all configured recipients before sending or managing correspondence.
  - body: { TransactionType: string }
- `POST https://api.mcp.ai/api/spondyr/search/filter/create` — Create a new search filter for a transaction type in Spondyr. Search filters enable you to define searchable fields within your transaction data. Once created, these filters allow you to quickly searc
  - body: { Tag: string, Name: string, TransactionType: string }
- `POST https://api.mcp.ai/api/spondyr/search/filter/delete` — Deletes a specific search filter from the Spondyr system. Use this when you need to remove a search filter that is no longer needed. Both the filter name and transaction type must exactly match the va
  - body: { Search: string, TransactionType: string }
- `POST https://api.mcp.ai/api/spondyr/search/filter/get` — Retrieves details of a specific search filter in Spondyr by name and transaction type. Returns the filter's name, tag value, and associated transaction type. Use this when you need to look up an exist
  - body: { Search: string, TransactionType: string }
- `POST https://api.mcp.ai/api/spondyr/search/filters/list` — Tool to list all search filters for a transaction type. Use when you need to discover available filters before searching correspondence.
  - body: { TransactionType: string }
- `POST https://api.mcp.ai/api/spondyr/search/spondyrs` — Search for generated correspondence (spondyrs) by multiple criteria including batch ID, event type, and custom search filters. Returns paginated results with delivery status, recipient information, an
  - body: { Page?: integer, PageSize?: integer, EventType?: string, SortOrder?: string, SearchName?: string, SortColumn?: string, SearchValue?: string, BatchReferenceID?: string }
- `POST https://api.mcp.ai/api/spondyr/sso/stub` — Tool to create a one-time SSO user stub in Spondyr. Use after application authentication to generate a temporary SSO token for embedding or redirecting users.
  - body: { Role: string, LastName: string, TimeZone?: string, FirstName: string, TenantToken?: string, ApplicationUserID: string }
- `POST https://api.mcp.ai/api/spondyr/template/get` — Retrieve detailed configuration for a specific correspondence template. Returns template content reference ID, event type, recipients, delivery methods, conditions, and search filters. Use this action
  - body: { Template: string, TransactionType: string }
- `POST https://api.mcp.ai/api/spondyr/templates/list` — List all templates configured for a transaction type. Use this to discover available templates before generating correspondence or to audit template configurations. Returns template metadata including
  - body: { TransactionType: string }
- `POST https://api.mcp.ai/api/spondyr/transaction/type/get` — Tool to retrieve details of a specific transaction type. Use when inspecting a transaction type schema. Returns the schema definition including JSON structure and CSV field mappings. Example: "Get tra
  - body: { TransactionType: string }
- `POST https://api.mcp.ai/api/spondyr/transaction/type/update` — Updates an existing transaction type's name and/or JSON schema in Spondyr. Use this tool to: - Modify the JSON schema/template of a transaction type to add, remove, or change data fields - Rename an e
  - body: { Name: string, TemplateJSON: string, TransactionType: string }

## Example prompts
- "What can I do in Spondyr?"
- "Show me a summary of my Spondyr account"

## More
- Page: https://mcp.ai/spondyr
- Agent spec (llms.txt): https://mcp.ai/spondyr/llms.txt
- Postman collection: https://mcp.ai/spondyr/postman.json