Guides¶
Guides are end-to-end walkthroughs built around real scenarios. Each guide takes you from an empty project to a working, governed API, AI, or MCP setup on WSO2 API Platform.
Each guide gives you:
- The prerequisites and, where it helps, the architecture of what you will build
- Step-by-step instructions with the expected result after each step
- A way to verify that everything works end to end
- A runnable companion sample, where available
Use guides to see how components such as AI Gateway, AI Workspace, Developer Portal, and MCP Hub work together. For details on a single feature, see the product documentation for Cloud, API Manager, AI Gateway, or API Portal.
Explore what you can build¶
Browse by what you want to achieve, or by the service provider you already work with.
Browse by use case¶
The guides below are grouped by use case. Whether you want to secure and manage your APIs, control LLM usage and cost, monitor AI traffic, turn your APIs into MCP tools, give AI agents access to your APIs as MCP tools, or monetize your usage, browse the guides for your use case and try them out on your own from start to finish.
Govern LLM Traffic¶
Route, secure, and control cost for requests to LLM providers.
-
Set up a governed multi-model LLM proxy with cost controls and failover
Spread traffic across models with per-team token budgets, PII masking, and caching.
-
Enforce token-based rate limiting on an LLM proxy
Put a token quota on an LLM proxy to protect your provider budget.
-
Block prompt injection and unsafe requests with LLM proxy guardrails
Chain guardrails to reject unsafe prompts before they reach your model.
-
Enforce a consistent AI persona with the prompt decorator policy
Give every client the same on-brand AI persona without code changes.
-
Observe LLM traffic on the AI Gateway
Track requests, latency, tokens, cost, and guardrail activity for LLM proxies.
Expose and Govern MCP Servers¶
Turn APIs into MCP tools, publish them, and control access.
-
Convert a REST API into an MCP tool for Claude Desktop
Expose a REST API as a governed MCP server and use it in Claude Desktop.
-
Expose a multi-step API workflow as an MCP tool
Combine several API calls into one Arazzo workflow and expose it as an MCP tool.
-
Build an AI agent that uses aggregated MCP tools from multiple APIs
Connect an AI agent to several governed MCP servers through AI Gateway.
-
Publish MCP servers to a governed catalog
Publish MCP servers to API Portal and MCP Hub for governed discovery.
-
Reduce MCP tool poisoning risk with the MCP Access Control policy
Use the MCP Access Control policy to reduce exposure to tool poisoning.
-
Observe MCP traffic on the AI Gateway
Track tool calls, agent sessions, latency, and errors for MCP proxies.
Discover APIs and MCP Servers¶
Find APIs and MCP servers in the Developer Portal and MCP Hub, and make your first call.
-
Go from zero to a working API call using the Developer Portal
Find an API, try it with an API key, and subscribe to a rate-limited plan.
-
Find and connect to an enterprise MCP server from the MCP Hub
Find an MCP server in the MCP Hub and connect Claude Desktop to it.
Configure AI Coding Assistants with AI Gateway¶
Route Claude Code, Gemini CLI, Codex, and GitHub Copilot traffic through AI Gateway.
-
Configure Claude Code with AI Gateway
Route Claude Code requests through AI Gateway with an App LLM Proxy.
-
Configure Claude Code with AI Gateway using a Claude subscription
Route Claude Team or Enterprise traffic through AI Gateway with enterprise identity.
-
Configure Google Gemini CLI with AI Gateway
Route Gemini CLI requests through AI Gateway with an App LLM Proxy.
-
Configure OpenAI Codex CLI with AI Gateway
Route Codex CLI requests through AI Gateway with an App LLM Proxy.
-
Configure GitHub Copilot with AI Gateway
Route GitHub Copilot CLI and Copilot Chat in VS Code requests through AI Gateway with an App LLM Proxy.
Monetize APIs and MCP Tools¶
Charge for API calls and MCP tool usage with usage-based plans.
-
Monetize a REST API with Stripe
Charge for a REST API with a pay-as-you-go plan billed through Stripe.
-
Monetize MCP tools with the self-hosted AI Gateway
Bill AI agents per MCP tool call using AI Gateway, Moesif, and Stripe.
Manage and Govern APIs¶
Publish your APIs as managed API proxies, and control who calls them with authentication, rate limits, and audit logs.
-
Build an AI app with Claude Code that calls governed APIs
Give Claude Code governed, rate-limited access to your backend APIs.
Connect Third-Party Gateways¶
Connect gateways such as AWS API Gateway, discover their APIs, and govern them from one control plane.
-
Discover APIs from AWS API Gateway
Discover APIs on AWS API Gateway and govern them from one control plane.
Expose Real-Time APIs¶
Put an API proxy in front of WebSocket backends and push live updates to every client.
-
Build a WebSocket-based real-time notification system
Stream real-time notifications to clients through a WebSocket API proxy.
Browse by service provider¶
The resources below are grouped by service provider. Whether you use Amazon Bedrock, Azure OpenAI, Claude, OpenAI, Gemini, Mistral, GitHub Copilot, or Stripe, find the relevant guides, tutorials, and setup references for your deployment.
AI and cloud providers
AWS¶
Govern AI traffic to Amazon Bedrock with guardrails and workload identity, discover and govern APIs on Amazon API Gateway, and integrate with AWS observability services.
Azure¶
Govern Azure OpenAI and Azure AI Foundry traffic, moderate content with Azure AI Content Safety, and secure APIs with Microsoft Entra ID.
Anthropic¶
Route Claude Code through AI Gateway, connect Claude Code and Claude Desktop to governed APIs and MCP servers, and govern traffic to Claude models.
OpenAI¶
Route OpenAI Codex CLI through AI Gateway, govern traffic to OpenAI models, and use OpenAI embeddings for semantic caching and guardrails.
Google¶
Route Google Gemini CLI through AI Gateway, govern Gemini model traffic, and send gateway telemetry to Google Cloud.
Mistral¶
Govern traffic to Mistral AI models, and use Mistral embeddings for semantic caching and semantic guardrails.
Developer tools
GitHub¶
Route GitHub Copilot through AI Gateway, create API proxies from GitHub repositories, and design APIs with Copilot in VS Code.
Billing and payments
Stripe¶
Sell paid subscription plans for your APIs, and bill consumers for their usage through Stripe.