Wso2 Docs MCP Server
Semantic search over WSO2 API Manager, Identity Server, Choreo and Ballerina docs
- Pricing
- Open source
- Platforms
- CLI, self-hosted
- Runs
- Locally
- Version
- 1.3.16
- Listing updated
- today
Similar MCP servers
About Wso2 Docs MCP Server
Wso2 Docs MCP Server is an open-source MCP server for developer tools. It runs locally on your machine and is started by your AI client.
An unofficial, community-built server, not affiliated with WSO2, that indexes WSO2 documentation into a PostgreSQL pgvector database and answers by retrieval-augmented search. It pulls raw Markdown from WSO2's public GitHub repositories via the Git Trees API, and crawls the site for products without docs repos, such as the WSO2 Library.
Seven sources are indexed: API Manager, Micro Integrator, Ballerina Integrator, Choreo, Identity Server, Ballerina and the WSO2 Library. You need Node.js 20 or later and Docker for pgvector. Embeddings default to local Ollama (nomic-embed-text), fall back to an in-process HuggingFace ONNX model if Ollama is not running, and can use OpenAI, Gemini or Voyage with an API key.
You run a migration and a crawl once, then the server is launched on demand by Claude Desktop, Claude Code, Cursor or VS Code over stdio.
Install
Run in a terminal
claude mcp add wso2-docs-mcp-server --env DATABASE_URL='<DATABASE_URL>' --env OPENAI_API_KEY='<OPENAI_API_KEY>' --env GEMINI_API_KEY='<GEMINI_API_KEY>' --env VOYAGE_API_KEY='<VOYAGE_API_KEY>' -- npx -y wso2-docs-mcp-serverAdd to claude_desktop_config.json
{
"mcpServers": {
"wso2-docs-mcp-server": {
"command": "npx",
"args": [
"-y",
"wso2-docs-mcp-server"
],
"env": {
"DATABASE_URL": "<DATABASE_URL>",
"OPENAI_API_KEY": "<OPENAI_API_KEY>",
"GEMINI_API_KEY": "<GEMINI_API_KEY>",
"VOYAGE_API_KEY": "<VOYAGE_API_KEY>"
}
}
}
}Add to ~/.cursor/mcp.json
{
"mcpServers": {
"wso2-docs-mcp-server": {
"command": "npx",
"args": [
"-y",
"wso2-docs-mcp-server"
],
"env": {
"DATABASE_URL": "<DATABASE_URL>",
"OPENAI_API_KEY": "<OPENAI_API_KEY>",
"GEMINI_API_KEY": "<GEMINI_API_KEY>",
"VOYAGE_API_KEY": "<VOYAGE_API_KEY>"
}
}
}
}Add to .vscode/mcp.json
{
"servers": {
"wso2-docs-mcp-server": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"wso2-docs-mcp-server"
],
"env": {
"DATABASE_URL": "<DATABASE_URL>",
"OPENAI_API_KEY": "<OPENAI_API_KEY>",
"GEMINI_API_KEY": "<GEMINI_API_KEY>",
"VOYAGE_API_KEY": "<VOYAGE_API_KEY>"
}
}
}
}Add to ~/.codeium/windsurf/mcp_config.json
{
"mcpServers": {
"wso2-docs-mcp-server": {
"command": "npx",
"args": [
"-y",
"wso2-docs-mcp-server"
],
"env": {
"DATABASE_URL": "<DATABASE_URL>",
"OPENAI_API_KEY": "<OPENAI_API_KEY>",
"GEMINI_API_KEY": "<GEMINI_API_KEY>",
"VOYAGE_API_KEY": "<VOYAGE_API_KEY>"
}
}
}
}Add to your client's MCP settings (most use this shape)
{
"mcpServers": {
"wso2-docs-mcp-server": {
"command": "npx",
"args": [
"-y",
"wso2-docs-mcp-server"
],
"env": {
"DATABASE_URL": "<DATABASE_URL>",
"OPENAI_API_KEY": "<OPENAI_API_KEY>",
"GEMINI_API_KEY": "<GEMINI_API_KEY>",
"VOYAGE_API_KEY": "<VOYAGE_API_KEY>"
}
}
}
}Using several servers? Build one config file with the MCP config generator.
Configuration
DATABASE_URLPostgreSQL connection string for pgvector (e.g. postgresql://user:pass@localhost:5432/wso2docs)RequiredEMBEDDING_PROVIDEREmbedding backend to use: ollama (default, local), openai, gemini, or voyageOPENAI_API_KEYRequired only when EMBEDDING_PROVIDER=openaiGEMINI_API_KEYRequired only when EMBEDDING_PROVIDER=geminiVOYAGE_API_KEYRequired only when EMBEDDING_PROVIDER=voyage
Tools this server provides (1)
Taken from the project documentation; the running server may differ.
- search_wso2_docs
- Semantic search across WSO2 products with an optional product filter.
What it does
- Semantic doc search
- search_wso2_docs searches across all indexed products, with an optional product filter.
- Seven doc sources
- API Manager, Micro Integrator, Ballerina Integrator, Choreo, Identity Server, Ballerina and WSO2 Library.
- pgvector storage
- Embeddings stored in PostgreSQL with pgvector, run via Docker.
- Choice of embeddings
- Ollama, HuggingFace ONNX fallback, OpenAI, Gemini or Voyage.
- Incremental indexing
- Crawl command can index one product or force a re-index.
- Common clients
- Setup shown for Claude Desktop, Claude Code, Cursor and VS Code.
Good for
- Ask how to configure an API Manager gateway from your editor
- Look up Identity Server settings while coding
- Find Ballerina language guidance without leaving the IDE
- Keep a private, local copy of WSO2 docs for offline search
Pricing
Open source
Free community project
Wso2 Docs MCP Server FAQ
Is it official?
No. The README calls it an unofficial community project not affiliated with or endorsed by WSO2.
Do I need an API key?
Not by default; local Ollama or the built-in ONNX fallback needs none. OpenAI, Gemini and Voyage need their keys.
What do I need installed?
Node.js 20 or newer and Docker for the pgvector database.
How do I install it?
npm install -g wso2-docs-mcp-server, or run it with npx.
Is Wso2 Docs MCP Server free?
Yes. Wso2 Docs MCP Server is open source, so you can use and self-host it for free.
How do I add Wso2 Docs MCP Server to Claude Code?
Run this command in your terminal: claude mcp add wso2-docs-mcp-server --env DATABASE_URL='<DATABASE_URL>' --env OPENAI_API_KEY='<OPENAI_API_KEY>' --env GEMINI_API_KEY='<GEMINI_API_KEY>' --env VOYAGE_API_KEY='<VOYAGE_API_KEY>' -- npx -y wso2-docs-mcp-server
What are the best alternatives to Wso2 Docs MCP Server?
The closest alternatives to Wso2 Docs MCP Server are REA, Context7, Chrome DevTools MCP, Codebase Memory and GitHub.
Where this comes from
- Description: written from the project's README.
- Install steps: from the official MCP Registry entry.


