External Two squares, one overlapping the bottom one. Top square has an arrow pointing away, as if leading you away

Introduction

The Zywave MCP server exposes your Zywave platform to any AI assistant or development tool that supports the Model Context Protocol (MCP). Search accounts, research prospects, retrieve insurance content, and generate producer research briefs through a natural-language interface in the tool of your choice.

Property Value
Server URL https://ai.zywave.com/mcp/v1
Transport Streamable HTTP (MCP spec 2025-03-26)
Authentication OAuth 2 with PKCE
Protocol version 2025-03-26
Tools exposed 22

Note: The MCP server only surfaces data the authenticated user is licensed and permissioned to access within Zywave. No data is accessible beyond what that user can see in the Zywave application itself.


Compatible clients

Any MCP-compliant client that supports Streamable HTTP transport and OAuth 2.1 can connect to the Zywave MCP server. Verified integrations include:

Note: The server uses Streamable HTTP only. The older SSE transport (pre-March 2025 MCP spec) is not available. Clients must support the 2025-03-26 protocol version or later.


Connecting

Connector directories (one-click)

For clients that publish a connector directory, the Zywave MCP server is listed and can be connected with a single click. The client handles the OAuth flow automatically.

Manual connection

For clients that support adding a custom MCP server by URL, use the following endpoint and complete the OAuth authorization flow when prompted.

https://ai.zywave.com/mcp/v1

Capabilities

The server exposes 22 tools across four functional areas. Read-only tools carry readOnlyHint: true and can run without per-call confirmation in clients that support auto-approval. Write tools carry destructiveHint: true and will prompt for confirmation.

Note on the rationale parameter: Every tool requires a rationale string explaining why it is being invoked. AI clients populate this automatically. If you are calling the server programmatically, pass a brief description of the calling context.

Book of business

Search and manage CRM records within the authenticated user's Zywave tenant.

Tool Type Description
account_search read Search accounts by name, state, classification, client size, NAICS code, or line of business. Supports OData $filter, $orderBy, $skip, and $top.
account_get read Retrieve full details for a single account by ID.
account_create write Create a new account. Duplicate detection runs automatically; returns matches for confirmation before proceeding.
account_update write Update fields on an existing account. Only supplied fields are changed; omitted fields retain their current values.
account_delete write Archive or permanently delete an account. Soft delete (archive) by default; pass permanent: true for irreversible deletion.
account_restore write Restore a previously archived account.
account_contact_search read Search contacts associated with accounts in your book of business.
account_contact_get read Retrieve full details for a single contact by ID.
account_contact_create write Create a new contact linked to an existing account.
account_contact_update write Update fields on an existing contact. Only supplied fields change.
account_contact_delete write Archive or permanently delete a contact.
account_contact_restore write Restore a previously archived contact.

Prospecting

Search Zywave's company intelligence and personal-lines household databases for new prospects outside your existing book of business.

Tool Type Description
discovery_company_search read Search commercial prospects by industry, geography, employee count, revenue, and NAICS code.
discovery_company_contact_get read Return decision-maker contacts for a company. Pass enrich: false to preview at no cost; enrich: true returns email and phone numbers and incurs a per-company charge.
discovery_household_search read Search personal-lines households by property location, state, ZIP code, and estimated real estate value.
discovery_household_contact_get read Return contacts associated with a personal-lines household by MSID.

Content library

Search and retrieve insurance resources covering commercial lines, employee benefits, and personal lines.

Tool Type Description
content_search read Search the Zywave content library by topic, risk, or client situation. Returns metadata and file download URLs.
content_get_full_text read Read the full text body of a content item by ID.
content_download read Generate a presigned download URL for a content file by ID. URLs are time-limited.

Research briefs

Generate and retrieve producer research briefs tied to a specific producer MSID.

Tool Type Description
research_brief_generate write Generate a research brief for a producer MSID and line of business (Commercial, Benefits, or PersonalLines). Runs synchronously; progress notifications include a publicId for later retrieval.
research_brief_get read Retrieve a previously generated research brief by its publicId. Do not call while generation is in progress.

Session identity

Tool Type Description
system_who_am_i read Return the authenticated user's identity — name, email, organization, and organizational unit. Primarily for troubleshooting.

Authentication

The Zywave MCP server requires OAuth 2.1 with PKCE (S256 challenge method). Access tokens are issued by the Zywave identity server at https://auth.zywave.com and passed as a Bearer token on every request.

Discovery endpoints

Endpoint URL
Protected resource metadata https://ai.zywave.com/mcp/v1/.well-known/oauth-protected-resource
OIDC discovery https://auth.zywave.com/.well-known/openid-configuration
Authorization endpoint https://auth.zywave.com/connect/authorize
Token endpoint https://auth.zywave.com/connect/token
Revocation endpoint https://auth.zywave.com/connect/revocation

Authorization code flow

  1. Build an authorization request to https://auth.zywave.com/connect/authorize with response_type=code, your client_id, redirect_uri, requested scope, and a PKCE code_challenge (S256).
  2. The user signs in with their Zywave credentials and approves the requested scopes.
  3. Exchange the returned code for an access token at https://auth.zywave.com/connect/token, including your code_verifier.
  4. Pass the access token as Authorization: Bearer {token} on every MCP request.
  5. Refresh tokens are supported. Request the offline_access scope to receive a refresh token alongside the access token.

Client registration

Dynamic Client Registration is not currently supported. To obtain a client_id and client_secret for a custom integration, register your application through the Zywave Admin tool. MCP clients listed in the Zywave connector directory have pre-registered credentials managed by Zywave.


Scopes & permissions

Scope Purpose Required for
mcp Identifies the token as issued for MCP access All tools
api.accounts Read and write access to accounts and contacts account_*, account_contact_*
api.content Read access to the content library content_*
api.companies Access to company and household discovery data discovery_*

Tokens are scoped to the permissions of the authenticated user. A user whose Zywave license does not include discovery data cannot access discovery tools regardless of the scopes requested.

Contact enrichment billing: The discovery_company_contact_get tool supports an enrich parameter that returns direct email addresses and phone numbers. Enriching a record incurs a per-company charge billed to the agency. Always call with enrich: false first to preview contacts at no cost, then request enrich: true only after the user explicitly confirms.


IT admin guidance

Data access model

The MCP server operates entirely within the authenticated user's existing Zywave permissions. It does not use a privileged service account and cannot access data belonging to other users or other organizations. All reads and writes are subject to the same access controls enforced in the Zywave application.

Data flow

Network requirements

No inbound firewall changes are required. If your organization uses an egress allowlist, ensure the following are reachable:

For cloud-brokered clients such as Claude, requests to the MCP server originate from the AI provider's cloud IP ranges rather than from client machines directly. Consult your AI provider's documentation for their published egress IP ranges.

Security

Revoking access

Level How to revoke
User Disconnect the MCP server in the AI client's settings, or call https://auth.zywave.com/connect/revocation directly
Admin Revoke or rotate the OAuth client credentials in the Zywave Admin tool, which immediately invalidates all active tokens issued to that client

Troubleshooting

Symptom Likely cause Resolution
401 Unauthorized Access token expired or revoked Re-authorize through the client's connector settings
Authorization page does not load Pop-up blocked or auth.zywave.com unreachable Allow pop-ups for the client origin and verify auth.zywave.com is reachable from your network
Tool returns empty results User's Zywave license doesn't cover that data area Verify the user has the appropriate Zywave product license
Contact enrichment fails Agency has no enrichment credits Contact your Zywave account manager to add enrichment to the subscription
Research brief fails to generate MSID not found or producer record inactive Verify the MSID exists and is active in the Zywave application
Client cannot connect — transport error Client uses SSE transport (pre-2025 MCP spec) Upgrade to an MCP client that supports Streamable HTTP (2025-03-26 spec or later)

Support

For issues with the Zywave MCP server, contact Zywave support through your normal support channel.

For issues specific to a particular AI client, consult that client's support documentation.