Wso2 Docs MCP Server logo

Wso2 Docs MCP Server

Searches indexed WSO2 documentation semantically through MCP tools backed by PostgreSQL and pgvector.

Install Wso2 Docs MCP Server

Pick your client, then add it in one click or paste the config.

STDIONode.js
~/Library/Application Support/Claude/claude_desktop_config.json
claude_desktop_config.json
{
  "mcpServers": {
    "wso2-docs-mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "wso2-docs-mcp-server"
      ],
      "env": {
        "DATABASE_URL": "YOUR_VALUE_HERE",
        "EMBEDDING_PROVIDER": "YOUR_VALUE_HERE"
      }
    }
  }
}

Settings → Developer → Edit Config, merge this into mcpServers, then fully quit and reopen Claude Desktop.

Values are written into the snippet above so you can paste it as is. They never leave your browser.

We couldn’t confirm it starts correctly

The install command didn't complete successfully in our automated test.

npx -y wso2-docs-mcp-server

ntimes/linux-x64/native/libonnxruntime_providers_cuda.so to /tmp/allmcps-pre/node_modules/onnxruntime-node/bin/napi-v6/linux/x64/libonnxruntime_providers_cuda.so npm error Killed npm notice npm notice New major version of npm available! 10.9.9 -> 12.2.1 npm notice Changelog: https://github.com/npm/cli/releases/tag/v12.2.1 npm notice To update run: npm install -g npm@12.2.1 npm notice npm error A complete log of this run can be found in: /home/user/.npm/_logs/2026-10-28T12_48_32_156Z-debug-0.log

This is an experimental automated check and can have false negatives — missing environment variables, a slow cold install, etc. It doesn’t necessarily mean something’s wrong. Last checked Today.

Overview

The wso2-docs-mcp-server MCP server indexes WSO2 documentation and exposes semantic search through MCP. It supports API Manager, Micro Integrator, Ballerina Integrator, Choreo, Identity Server, Ballerina, and the WSO2 Library. Documentation is ingested from GitHub repositories where available, with web crawling as a fallback, then stored in PostgreSQL with pgvector embeddings. Reach for it when an AI coding client needs searchable WSO2 product guidance rather than manually browsing documentation.

Use cases

  • Search WSO2 product documentation from an AI coding client
  • Find deployment guidance across API Manager and Micro Integrator
  • Limit semantic searches to a specific WSO2 product
  • Index selected documentation products for local testing
  • Explain cross-product WSO2 concepts with retrieved references

Key features

  • Semantic search over indexed WSO2 documentation
  • GitHub Markdown ingestion with web-crawl fallback
  • PostgreSQL and pgvector storage
  • Local Ollama or HuggingFace ONNX embeddings
  • Product-filtered and cross-product MCP tools
  • Support for OpenAI, Gemini, and Voyage AI embeddings

Tools4

What Wso2 Docs MCP Server lets your agent do. Expand a tool for its parameters.

Self-reported~89 tokens of context

Security & health

What it can reach and how reliably it runs — from our own checks, not the maintainer’s claims.

ActiveLast checked 2d ago

Recent health check succeeded.

4/4 checks healthy over the last 20d

Supply-chain signal

No high-severity advisories surfaced by our automated scan.

Critical 0High 0Medium 0Low 0

Scanned 2d ago via OSV.dev · wso2-docs-mcp-server (npm)

Adoption & maintenance

Factual signals from GitHub, npm, and our automated checks — not a rating.

GitHub stars3Stargazers on the source repository.
npm downloads596Package downloads in the last 30 days.
Last commit6d agoMost recent push to the default branch.
Install checkInconclusiveInstall command did not finish in our automated test.
Tools exposed4Callable tools this server registers over MCP.

How Wso2 Docs MCP Server works

What wso2-docs-mcp-server MCP server does

The wso2-docs-mcp-server MCP server gives MCP-compatible AI clients semantic access to indexed WSO2 documentation. Its source catalog covers API Manager, Micro Integrator, Ballerina Integrator, Choreo, Identity Server, Ballerina, and the WSO2 Library. Search results can include a title, excerpt, source URL, product identifier, section, and relevance score.

The project is an unofficial community implementation and is not affiliated with or endorsed by WSO2. It is useful for assistants helping with WSO2 configuration, deployment, product concepts, and documentation lookup across multiple product families.

How it works

Documentation is collected by a dual ingestion process. For products with suitable public documentation repositories, the crawler reads raw Markdown through GitHub's Git Trees API. Products without dedicated GitHub documentation repositories can be handled through the web-crawl fallback. The resulting content is embedded and stored in PostgreSQL with the pgvector extension.

Embeddings use Ollama by default, with the nomic-embed-text model shown in the setup instructions. If Ollama is unavailable, the server can use HuggingFace ONNX inference in process and download the model when needed. OpenAI, Google Gemini, and Voyage AI are also supported as cloud embedding providers.

The MCP process runs on demand through an AI client's standard input/output transport. A PostgreSQL connection must point the server and its indexing commands at the same database. Database migration should be run before crawling, and again if the embedding dimensions change after switching providers.

Setup and configuration

The wso2-docs-mcp-server MCP server requires Node.js 20 or newer and Docker for the pgvector database. Install it globally from npm, or clone the repository and build it locally. Start the supplied PostgreSQL/pgvector Compose service, run the migration command, and index either all products or a selected product. The crawler also supports a result limit for focused tests and a force option for re-indexing unchanged pages.

The primary connection setting is DATABASE_URL. EMBEDDING_PROVIDER selects the embedding backend; the documented default is Ollama. Cloud providers require their corresponding API key, while the local Ollama and HuggingFace paths do not require an API key. After indexing, configure the MCP command in Claude Desktop, Claude Code, Cursor, or VS Code. An npm installation can invoke wso2-docs-mcp-server; a source checkout can launch the built Node entry point.

Tools and capabilities

The wso2-docs-mcp-server MCP server exposes four tools:

  • search_wso2_docs searches across the complete documentation collection and accepts optional product and result-limit filters.
  • get_wso2_guide restricts a search to one supported product ID, such as apim, mi, choreo, or ballerina.
  • explain_wso2_concept performs a broad cross-product concept search and returns eight top results.
  • list_wso2_products returns the supported product IDs and their base URLs.

Use the product-specific tool when answers must stay within one WSO2 product. Use the cross-product tools when a concept may span API management, integration, identity, or Ballerina documentation.

Limitations and notes

The repository describes this as an unofficial project, so it should not be treated as an official WSO2 support channel. Search quality depends on the local index and embedding configuration; documentation must be crawled before it can be retrieved. The server also depends on a running PostgreSQL/pgvector service and a completed migration. Changing embedding providers may require migration because vector dimensions can differ. The documented product list and crawl sources should be checked when current documentation coverage matters.

Reviews

No reviews yet — be the first to share how it worked for you.

Frequently Asked Questions about Wso2 Docs MCP Server

wso2-docs-mcp-server is an MCP server that connects AI assistants to indexed WSO2 documentation for API Manager, Micro Integrator, Choreo, Ballerina, Identity Server, and the WSO2 Library. Its main tools search documentation, query one product, explain concepts across products, and list supported products.

Install it with `npm install -g wso2-docs-mcp-server`, or clone the repository and install dependencies with npm. You must also start the supplied pgvector database, run the database migration, crawl documentation, and then configure the command in your MCP client.

It supports API Manager, Micro Integrator, Ballerina Integrator, Choreo, Identity Server, Ballerina, and the WSO2 Library. The corresponding product IDs are `apim`, `mi`, `bi`, `choreo`, `is`, `ballerina`, and `library`.

Yes, wso2-docs-mcp-server works with Cursor through a project-level `.cursor/mcp.json` configuration. The documented setup uses the server command and environment values for `DATABASE_URL` and `EMBEDDING_PROVIDER`; an npm installation can run the command directly.

It supports Ollama by default, with HuggingFace ONNX as an automatic fallback when Ollama is unavailable. Cloud providers require their relevant API keys.

Related MCP servers

Add a badge to your READMEShow it’s listed — live SVG, Markdown or HTML.

AllMCPs Directory Badge

Full Badge Customizer

Showcase your server listing on GitHub or your project documentation. Embed this dynamic SVG badge to highlight official listing status and live engagement.

Badge Style:
Live Dynamic SVG PreviewWso2 Docs MCP Server AllMCPs Directory Badge
Markdown (GitHub README)
[![AllMCPs](https://allmcps.com/api/badge/wso2-docs-mcp-server?style=directory)](https://allmcps.com/mcp/wso2-docs-mcp-server)
HTML Embed
<a href="https://allmcps.com/mcp/wso2-docs-mcp-server"><img src="https://allmcps.com/api/badge/wso2-docs-mcp-server?style=directory" alt="Wso2 Docs MCP Server on AllMCPs" /></a>