Overview
The Zylo MCP Server enables MCP-capable AI tools to interact directly with your Zylo data using Model Context Protocol (MCP) Streamable HTTP transport. Query your SaaS portfolio, update resources, and generate insights and reports -- all through conversation.
In general, models from major labs (Google, Anthropic, OpenAI) will perform best. Use lower-tier models with caution (e.g. Haiku), as they're more prone to hallucination when interacting with any MCP server.
Key Benefits
- Natural Language Interface: Ask questions about your SaaS portfolio in plain language
- Direct Data Access: Your AI tools query your Zylo data in real-time
- Powerful Querying: Build complex multi-resource queries using Zylo's Report Builder
- Generate Insights: Create reports, graphs, and charts; or have your AI recommend an action plan
- Safe Operations: Granular permissions control what your AI can read and modify
- Secure Communication: All data transmitted over TLS with OAuth or API key authentication
How It Works
- You ask a question in natural language using your AI assistant
- Your AI assistant determines which MCP tools to use based on your question
- Your client connects to
https://api.zylo.com/mcpusing OAuth or your API key - The MCP Server authenticates your request and checks permissions
- The MCP server executes the operation (query data, create resource, etc.)
- Results are returned to your AI assistant via JSON or SSE
- Your AI assistant formats the response into a readable answer for you
Step 1: Choose an authentication method
The Zylo MCP server supports two authentication methods: OAuth 2.0 with PKCE, and API tokens. For help in determining the best method for your use case, contact your Zylo admin or IT team.
Method A: OAuth 2.0 with PKCE
- This method uses your Zylo user account.
- A Zylo admin will have to ensure that your user account has the
MCProle and any relevant permissions via the User Management tab. - Configure your client with the Zylo MCP Server URL (
https://api.zylo.com/mcp), and when starting the first conversation, your client will open a browser window for you to sign into Zylo and authorize the MCP connection. - Access tokens are short-lived (5mins) and refresh automatically.
Method B: API Key
- This method uses an Enterprise API key.
- A Zylo admin will have to ensure that the key has been granted any relevant scopes via the Company Tokens tab.
- The complete API key combines the
token_idandtoken_secretwith a colon separator (token_id:token_secret). Note that lost token secrets cannot be recovered, so be sure to record it when creating the API key. - API keys require manual configuration and rotation.
See also:
- Tools Reference details the suite of tools included in the Zylo MCP server.
- Data Dictionary details all fields available across Zylo API resources.
Step 2: Client Configuration
Be sure to consult the official documentation for your client. The guides below may be helpful in configuring some of the more popular clients, but information from official documentation supersedes these guides.
Anthropic Claude
The Zylo MCP server is available as a community connector in Claude marketplace: https://claude.ai/directory/connectors/3a0d2d6f-9c40-4fe3-b2c0-1d91218ede9c
A Claude admin can enable the Zylo MCP connector for their organization by using the above link, or by navigating to Organization Settings -> Connectors -> Add -> All Available, then searching for Zylo.
Once enabled, users can find it in Claude Desktop by navigating to Settings -> Connectors, or in Claude Code via the /mcp command.
See also:
- Claude Code Docs: Connect to MCP servers
- Claude Docs: Third party connectors with remote MCP
- An older guide that predates the community connector: Setup for Claude
OpenAI ChatGPT
VS Code
Depending on the authentication method being used, add one of the below configs to .vscode/mcp.json.
For OAuth:
Note that VS Code will handle the OAuth PKCE flow automatically — a browser window will open for you to sign in on first use.
{
"servers": {
"zylo": {
"type": "http",
"url": "https://api.zylo.com/mcp"
}
}
}For API Key:
As best practice, we recommend storing your API key in a secure vault and calling it via an environmental variable rather than configuring it in plaintext as shown in the example below. For assistance with those configurations, contact your IT or InfoSec admin.
{
"servers": {
"zylo": {
"type": "http",
"url": "https://api.zylo.com/mcp",
"headers": {
"Authorization": "Bearer YOUR_TOKEN_ID:YOUR_TOKEN_SECRET"
}
}
}
}Further Reading
- Query Examples lists sample queries that can be good starting points for new users.
- Query Builder gives a deep-dive into the underlying functionality of how the MCP server formats queries.
- The official Model Context Protocol documentation may contain useful details or configuration info for your MCP-compatible client.
Common Troubleshooting Tips
Authentication Failed
- Common Cause: Invalid or missing API key
- Common Solution: Verify your API key format (
{token_id}:{token_secret}), and have a Zylo admin check to make sure the key hasn't been revoked in the Zylo admin panel
Permission Denied
- Common Cause: The API key doesn't have permission for the requested operation
- Common Solution: Ensure you're using the correct key (if there are multiple), and have a Zylo admin check the key's permissions in the Zylo admin panel
Connection Timeout
- Common Cause: Network connectivity issues or server unavailable
- Common Solution: Verify the MCP server URL is correct, verify that your network is stable, and check status.zylo.com for temporary outage
Query Timeout
- Common Cause: Your query is taking too long (>30 seconds).
- Common Solutions:
- Add more specific filters (date ranges, status, etc.)
- Reduce the number of fields requested
- Query smaller date ranges
- Break complex queries into smaller ones
Not Found
- Common Cause: The resource you're trying to update doesn't exist.
- Common Solutions:
- Verify the resource ID is correct
- Query for the resource first to confirm it exists
- Check if the resource was deleted
AI Assistant Not Using Tools
- Common Cause: MCP configuration issue
- Common Solution: Restart your AI assistant application, verify MCP configuration file syntax, check MCP server logs for errors, and ensure API key is properly formatted