Skip to main content
The Hyperline MCP server allows you to connect AI-powered tools and assistants directly to your Hyperline account. This enables you to interact with your billing data, manage customers, create invoices, and more using natural language through compatible AI applications.

​
What is MCP?

The Model Context Protocol (MCP) is an open standard that allows AI assistants to securely connect to external services and data sources. Think of it as a bridge between your AI tools (like Claude, Cursor, or other MCP-compatible applications) and Hyperline. With the Hyperline MCP server, you can ask your AI assistant to perform actions like:
  • “Show me all customers with overdue invoices”
  • “Create a new subscription for customer X”
  • “What’s my monthly recurring revenue?”
  • “Generate an invoice for the last month’s usage”

​
Setting up the MCP server

​
Enable the MCP server

To connect an AI assistant to Hyperline, you need to enable the MCP server and get your credentials:
  1. Go to your workspace Settings, section API
  2. Find the MCP Server section and click Enable
  3. Two sets of credentials are automatically generated for you:
    • OAuth credentials - The default authentication standard for MCP
    • API token - A token you can use directly if your application doesn’t support OAuth
We recommend using OAuth credentials when your AI application supports it, as this is the standard authentication method for MCP connections.
Copy and save your credentials securely — you won’t be able to see them again later in Hyperline.
Credentials are prefixed with prod_ for production or test_ for sandbox environments. We recommend starting with sandbox credentials to safely experiment with the MCP connection.

​
Configure your AI application

Once you have your credentials, configure your AI application to connect to the Hyperline MCP server. The configuration varies depending on which application you use, but generally requires the following information:
SettingValue
Server URLhttps://api.hyperline.co/mcp (or https://sandbox.api.hyperline.co/mcp for sandbox)
OAuth credentialsYour Client ID and Client Secret (if using OAuth)
API tokenYour Hyperline MCP token (if using direct authentication)
Refer to your AI application’s documentation for specific instructions on adding an MCP server connection.

​
Using the MCP server

Once connected, you can interact with Hyperline through your AI assistant using natural language. The assistant will automatically use the appropriate Hyperline operations based on your requests.

​
Example interactions

Here are some examples of what you can ask: Customer management
  • “List all my active customers”
  • “Find the customer with email [email protected]”
  • “Show me customer details for Acme Corp”
Subscriptions
  • “What subscriptions does customer X have?”
  • “Show me all subscriptions renewing this month”
Invoices and billing
  • “List unpaid invoices from the last 30 days”
  • “What’s the total amount billed this month?”
Analytics
  • “What’s my current MRR?”
  • “Show me revenue trends for the last quarter”

​
Security considerations

The MCP server inherits the same security measures as the Hyperline API:
  • All communication happens over HTTPS
  • Your credentials control what actions can be performed
  • Requests are subject to the same rate limits as regular API calls
  • You can revoke access at any time by disabling the MCP server in your settings
Treat your credentials as sensitive information. Only connect to AI applications you trust.

​
Troubleshooting

If your AI assistant can’t connect to Hyperline:
  1. Verify your credentials - Make sure the credentials are correct and the MCP server is still enabled
  2. Check the environment - Ensure you’re using the correct URL for your environment (production vs sandbox)
  3. Test the connection - Try a simple request like “List customers” to verify the connection works
If issues persist, contact our support team for assistance.