Skip to main content

Stream MCP Server

MCP (Model Context Protocol) is a standard way for AI clients to call tools and read resources from external systems.

The Stream MCP Server exposes Stream operations (payments, invoices, customers, products, etc.) as MCP tools so clients like Claude Desktop, Cursor, and VS Code can use them directly.

Resources vs tools: MCP resources (such as the OpenAPI documentation) do not require a Stream API key. Tools that call the Stream API—payments, customers, invoices, products, coupons, and the rest, do require a valid key in your client configuration.

Main Feature: API Documentation Integration

The primary feature of this MCP server is direct integration with Stream API documentation.

  • It exposes the full OpenAPI spec as an MCP resource.
  • AI clients can read the latest API schema and stay aligned with current endpoints.
  • This improves tool accuracy for request fields, validation, and endpoint usage.

Hosted endpoint

Stream hosts the MCP server at:

https://mcp.streampay.sa/mcp

Configure your client to use this URL. Include Authorization when you use tools that hit the Stream API; you can omit it if you only read documentation resources.


Client configuration (Claude Desktop / Cursor / VS Code)

Add this to your MCP config file (claude_desktop_config.json or mcp.json). Use the headers block whenever you rely on tools that require the Stream API (omit it for resources-only use, such as the OpenAPI spec).

{
"mcpServers": {
"stream": {
"url": "https://mcp.streampay.sa/mcp",
"headers": {
// Required for operational tools (payments, customers, etc.); omit if you only read docs resources (e.g. OpenAPI).
"Authorization": "Bearer sk_live_your_key_here"
}
}
}
}

Available Tools

ToolDescription
create_payment_linkCreate a new checkout / payment link
list_payment_linksPaginated list with optional status filter
get_payment_linkGet a single payment link by ID
deactivate_payment_linkDeactivate / archive a payment link

Customers

ToolDescription
create_customerCreate a customer with name, email, phone, metadata
list_customersPaginated list of customers
get_customerGet a single customer by ID
update_customerUpdate customer fields
delete_customerSoft-delete a customer

Products

ToolDescription
create_productCreate a one-time or recurring product
list_productsList products with optional type filter
get_productGet a single product by ID
update_productUpdate product name, description, or price
archive_productArchive a product

Coupons

ToolDescription
create_couponCreate a fixed or percentage discount coupon
list_couponsList coupons with optional status filter
get_couponGet a single coupon by ID
deactivate_couponDeactivate a coupon

Invoices

ToolDescription
create_invoiceCreate a ZATCA-compliant invoice
list_invoicesList invoices with filters
get_invoiceGet a single invoice by ID
send_invoice(Re)send an invoice via email / SMS
void_invoiceVoid / cancel an unpaid invoice

Payments

ToolDescription
list_paymentsList payments with filters
get_paymentGet payment details
refund_paymentIssue a full or partial refund

Resources

Reading these resources does not require your Stream API key in the client (unlike the operational tools above).

Resource URIDescription
stream://docs/openapiFull Stream OpenAPI spec (cached, auto-refreshed) — main documentation integration feature