How to Use the Getpaid MCP in LlamaIndex

Q: How do I load Getpaid tools into LlamaIndex?

Install llama-index-tools-mcp and instantiate BasicMCPClient. Call mcptoolspec.totoollistasync() to expose the billing tools to your agent.

Q: Can LlamaIndex search through Getpaid webhooks?

Yes. You can call listpaymentwebhooks and embed the resulting configuration JSON. This lets you query your current webhook routing using semantic search.

Q: Does the integration support refunds?

It does. You can include refundbillingpayment in your tool array. The agent will execute the transaction if the user's prompt demands action rather than just information retrieval.

Q: How do I restrict which Getpaid MCP Server tools LlamaIndex can use?

Pass specific tool names to the allowedtools list. This prevents your RAG app from accidentally calling createcheckoutsession when it should only be reading data.

Index live Getpaid transaction data directly into your LlamaIndex vector stores to build highly accurate billing RAG applications.

See Vinkius in Action

Works with every AI agent you already use

…and any MCP-compatible client

MCP Servers - Free for Subscribers

Connect Getpaid MCP to LlamaIndex

Create your Vinkius account to connect Getpaid to LlamaIndex and route execution through our secure gateway. The platform manages server hosting, runtime updates, and security layers. Configuration requires no manual server provisioning.

GDPR Free for Subscribers

Setup Getpaid with LlamaIndex

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Indexing Billing Histories

The `list_billing_invoices` tool pulls raw financial records straight into your LlamaIndex ingestion pipeline. Your application doesn't just read the data; it embeds every line item and metadata tag into a searchable vector space. When a user asks about Q3 spending, the query engine searches the index instead of guessing. You combine this with `list_billing_subscriptions` to ground the AI's answers in actual recurring revenue figures.

LlamaIndex MCP Server Search

The `get_customer_details` tool fetches specific user profiles for your RAG setup. Instead of writing SQL queries to find users who churned, your connection lets the agent pull the data and index the text. You pass the `BasicMCPClient` to your `FunctionAgent`. The agent uses `list_billing_customers` to build a localized knowledge base, making it trivial to query complex billing relationships using natural language.

Checkout State Retrieval

The `get_checkout_status` tool checks the exact condition of a pending transaction. LlamaIndex uses this to answer real-time questions about whether a specific link was paid. You restrict the agent's reach using the `allowed_tools` filter. If the agent only needs to verify payments, you expose `get_payment_details` and block the refund endpoints entirely.

Setup guide

Set up Getpaid MCP in LlamaIndex

Prerequisites

Python 3.10+ installed
llama-index-tools-mcp package
Active Vinkius subscription with a valid endpoint token

1

Install dependencies
Run pip install llama-index-tools-mcp llama-index-llms-openai. The MCP tools package provides BasicMCPClient and McpToolSpec.
2

Connect with BasicMCPClient
Point BasicMCPClient to your Vinkius endpoint URL. Replace [YOUR_TOKEN_HERE] with your token from cloud.vinkius.com. Supports SSE and Streamable HTTP transports.
3

Convert to LlamaIndex tools
Call mcp_tool_spec.to_tool_list_async() to convert all Getpaid MCP tools into native FunctionTool objects that any LlamaIndex agent can use.
4

Run with any LLM
Create a FunctionAgent with the tools and your preferred LLM. Swap OpenAI for Anthropic, Gemini, or any LlamaIndex-supported provider.

agent.py

from llama_index.tools.mcp import BasicMCPClient, McpToolSpec
from llama_index.core.agent.workflow import FunctionAgent
from llama_index.llms.openai import OpenAI

# Connect to the MCP
mcp_client = BasicMCPClient(
    "https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp"
)
mcp_tool_spec = McpToolSpec(client=mcp_client)

# Convert MCP tools to LlamaIndex tools
tools = await mcp_tool_spec.to_tool_list_async()

# Create and run the agent
agent = FunctionAgent(
    tools=tools,
    llm=OpenAI(model="gpt-4o"),
    system_prompt="You have access to Getpaid tools.",
)
response = await agent.run("List recent Getpaid data")

Get your connection token →

Independent Platform Disclaimer: Vinkius is an independent platform and is not affiliated with, endorsed by, sponsored by, verified by, or otherwise authorized by Getpaid. All third-party trademarks, logos, and brand names are the property of their respective owners. Their use on this website is strictly for informational purposes to identify service compatibility and interoperability.

Why Choose Vinkius

Vinkius connects your tools to AI with real-time monitoring and automatic cost savings — all from one dashboard.

Connect Getpaid now

Real-time monitoring

Live

visibility into every interaction

Connect your favorite tools to your AI and see exactly what's happening — every request, every response, in real time.

Built-in savings

60%

lower AI costs

Vinkius compresses data between your apps and your AI automatically. Lower bills every month — no configuration required.

Single dashboard

One

place for every integration

Every tool your AI connects to, managed from a single screen. One account, complete control.

Common questions about Getpaid MCP in LlamaIndex

Install `llama-index-tools-mcp` and instantiate `BasicMCPClient`. Call `mcp_tool_spec.to_tool_list_async()` to expose the billing tools to your agent.

Yes. You can call `list_payment_webhooks` and embed the resulting configuration JSON. This lets you query your current webhook routing using semantic search.

It does. You can include `refund_billing_payment` in your tool array. The agent will execute the transaction if the user's prompt demands action rather than just information retrieval.

Pass specific tool names to the `allowed_tools` list. This prevents your RAG app from accidentally calling `create_checkout_session` when it should only be reading data.

The integration handles raw subscription plans and customer IDs. If you pass `include_resources=True`, LlamaIndex writes these specific strings into your chosen vector database, meaning you must secure the vector store itself according to your compliance rules.

Use it with your favorite AI tools

Connect this server to Cursor, Claude, VS Code, and more.

OpenAI Agents SDK sdk-python

Google ADK sdk-python

Pydantic AI sdk-python

Vercel AI SDK sdk-typescript