Skip to main content

Documentation Index

Fetch the complete documentation index at: https://guide.withvayu.com/llms.txt

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

​
Overview

Vayu MCP lets AI assistants connect directly to your Vayu workspace using the Model Context Protocol (MCP). With it, your team can ask natural-language questions about customers, contracts, invoices, plans, catalog products, meters, credits, and custom field definitions, using live data from Vayu. It is built to remove the manual back and forth between your billing system and your AI tools. Instead of exporting reports or copying numbers into prompts, your team can query billing and revenue data directly in plain English. This is designed for customer-facing and internal operations use cases such as:
  • Looking up a customer or contract
  • Reviewing invoice status and payment state
  • Exploring billing plans and catalog products
  • Understanding meter configuration
  • Inspecting credit ledger activity
  • Powering AI copilots and internal ops workflows

​
What you can do with Vayu MCP

Today, Vayu MCP is focused on secure, read-oriented access to billing and revenue data in your Vayu account. You can use it for high-value finance and billing questions including revenue recognition by period (MRR, ARR, NRR, and GRR), deferred revenue, waterfall analysis, contract/renewal lookups, overdue AR, invoice status, and cross-entity search. Available tool groups include:
  • Customers
    • Find customers by name, external ID, or integration ID
    • Fetch full customer details
  • Contracts
    • Retrieve a contract by Vayu ID or supported integration ID
    • List contracts, optionally filtered by customer and other supported fields
  • Invoices
    • List invoices, optionally filtered by customer and other supported fields
    • Fetch full invoice details, including line items and totals
    • Check invoice payment status
  • Catalog products
    • List catalog products
    • Fetch a specific catalog product
  • Plans
    • List plans
    • Fetch a specific plan
  • Meters
    • List meters
    • Fetch a specific meter
  • Custom fields
    • List custom field definitions for supported entities
  • Credits
    • List credit ledger entries, optionally filtered by customer
Tool names are prefixed with vayu_ in MCP clients. List endpoints support pagination, and list results follow the server’s supported sorting semantics where available.

​
Supported AI clients

Vayu MCP works with MCP-compatible clients, including:
  • Claude Desktop
  • Claude Code
  • Cursor
  • claude.ai
  • MCP Inspector
  • Other MCP clients that support remote HTTP servers and OAuth-based authentication

​
Authentication

Vayu MCP is exposed as an OAuth 2.1 protected resource. When a compatible MCP client connects to the Vayu MCP endpoint, it discovers the authorization flow automatically through standard protected-resource metadata, including:
  • The WWW-Authenticate response header
  • The /.well-known/oauth-protected-resource metadata document
From there, the client launches the browser-based sign-in flow and obtains access tokens directly from the configured authorization server, currently Descope. This means there is no manual token copy and paste for supported clients. Users simply connect to the MCP server and complete sign-in in the browser.

​
Endpoints

Use the endpoint that matches your environment:
  • Staging*:* https://mcp.staging.withvayu.com/mcp
  • Production*:* https://mcp.withvayu.com/mcp

​
Connect Claude Desktop

  1. Open Claude Desktop MCP settings.
  2. Choose Add MCP server.
  3. Paste the Vayu MCP server URL.
  4. Click Connect.
  5. Complete the browser sign-in flow when prompted.
Once connected, Claude Desktop can use the Vayu MCP tools in your conversations. Example prompt: 
Find customers named Acme and show me their overdue invoices.

​
Connect Claude Code

Use the CLI to register the server: 
claude mcp add --transport http vayu https://mcp.withvayu.com/mcp
Then follow the sign-in flow when Claude Code prompts for authentication.

​
Connect Cursor

Cursor uses mcp.json for MCP server configuration.
  1. Open Cursor’s MCP configuration.
  2. Add the Vayu MCP server URL, https://mcp.withvayu.com/mcp, to your mcp.json file.
  3. Save the file and restart Cursor if needed.
  4. Complete the browser sign-in flow when prompted.
After that, enable the server in Cursor and start using Vayu tools from chat or agent workflows.

​
Connect Claude.ai

  1. Open Settings → Connectors.
  2. Choose Add custom connector.
  3. Paste the Vayu MCP server URL: https://mcp.withvayu.com/mcp
  4. Click Connect.
  5. Complete the browser sign-in flow when prompted.
Once connected, enable the connector in the conversation where you want to use Vayu.

​
Example questions to ask

Here are a few good examples:
  • What’s our recognized revenue this quarter?
  • Show me deferred revenue for the last 6 months.
  • List contracts renewing in the next 90 days.
  • Which invoices are overdue for Acme?
  • Show me the payment status of invoice inv_123.
  • List active contracts for customer cus_123.
  • What plans are active in this workspace?
  • Show me the details for meter mtr_123.
  • What is this customer’s current credit balance?
  • Search for all records related to Fordefi.

​
Security and scope

Vayu MCP is designed to be safe to use in production workflows.

A few important notes:
  • Access is scoped to the authenticated Vayu account.
  • The MCP server is read-only and authentication is handled through the OAuth protected-resource flow.
  • Tool responses are structured for AI use and optimized for natural-language workflows.
  • Pagination is supported on list operations for larger datasets.
  • Audit logging and rate limiting are built into the MCP service.
  • Input validation is enforced on every request.

​
Current limitations

At this stage, Vayu MCP is best suited for retrieval and analysis workflows.

Keep in mind that the current toolset is primarily read-focused and that available data depends on your Vayu account and configuration. Additionally, contract billing schedules and usage events aren’t currently exposed. Finally, client support depends on MCP compatibility and OAuth protected-resource support. \

​
Need help?

If you need help enabling Vayu MCP for your workspace, reach out to your Vayu team contact.