Sourcey

v1.0.0Developer Toolsstable

Precision documentation from OpenAPI, MCP, Doxygen, and Markdown guides. Static HTML you own.

api-documentationdeveloper-toolsdocsdocumentationdocumentation-generator
Share:
1,295
Stars
0
Downloads
0
Weekly
0/5

What is Sourcey?

Sourcey is a Model Context Protocol (MCP) server that allows AI assistants like Claude, Cursor, and VS Code to precision documentation from openapi, mcp, doxygen, and markdown guides. static html you own.

Precision documentation from OpenAPI, MCP, Doxygen, and Markdown guides. Static HTML you own.

This server falls under the Developer Tools category on MCPgee, the world's largest MCP server directory with 33,000+ servers.

Features

  • Precision documentation from OpenAPI, MCP, Doxygen, and Mark

Use Cases

Generate static HTML documentation from OpenAPI and Doxygen specs.
Create beautiful, owned API documentation.
Support Markdown guides and llms.txt format.
sourcey

Maintainer

LicenseAGPL-3.0
Languagetypescript
Versionv1.0.0
UpdatedMay 18, 2026
Statushealthy
Maintenanceactive

Works with

ClaudeOpenAIwindowsmacoslinux

Installation

Manual Installation

npx sourcey

Configuration

Configuration Details

Config File

claude_desktop_config.json

Performance

Response Metrics

Response Time< 200ms
ThroughputMedium

Resource Usage

Memory UsageLow
CPU UsageLow

How to Set Up and Use Sourcey

Sourcey is a documentation generation platform and MCP server that produces static HTML documentation from multiple input formats including OpenAPI specifications, MCP server definitions, Doxygen C++ XML output, Go godoc, Rust rustdoc JSON, and Markdown guides. It generates fully self-contained, deployable documentation sites that you own and host — no SaaS runtime required. Sourcey also auto-generates llms.txt and llms-full.txt context export files, making the documentation immediately usable by AI assistants, and supports auto-generated code samples in ten programming languages.

Prerequisites

  • Node.js 20+ installed (for the npm-based installation and CLI)
  • Your documentation source: an OpenAPI YAML/JSON spec, Doxygen XML output, Go source, Rust nightly build output, or Markdown files
  • An MCP-compatible client such as Claude Desktop or Cursor to use the MCP server mode
  • Optional: Homebrew (macOS/Linux), Docker, or Nix for alternative installation methods
1

Install Sourcey globally via npm

Install the Sourcey CLI globally using npm. Node.js 20 or higher is required.

npm install -g sourcey
2

Create a sourcey.config.ts file

Create a configuration file at the root of your project defining your documentation sources and site name.

import { defineConfig, openapi } from "sourcey";

export default defineConfig({
  name: "My API Docs",
  navigation: {
    tabs: [
      { tab: "API Reference", source: openapi("./openapi.yaml") },
    ],
  },
});
3

Generate your documentation site

Run the Sourcey CLI to build the static HTML output. The generated files can be deployed to any static hosting service.

sourcey build
4

Add Sourcey as an MCP server

To use Sourcey's documentation-querying capabilities from within an AI assistant, add it to your MCP client config.

{
  "mcpServers": {
    "sourcey": {
      "command": "npx",
      "args": ["sourcey", "mcp"]
    }
  }
}
5

Generate llms.txt for AI context

Sourcey auto-generates llms.txt and llms-full.txt during the build. These files provide structured documentation context that AI assistants can retrieve to answer questions about your API.

sourcey build --llms-txt
6

Preview the documentation locally

Start the local development server to preview the generated documentation before deploying.

sourcey dev

Sourcey Examples

Client configuration

MCP client config to enable Sourcey's documentation query tools in Claude Desktop.

{
  "mcpServers": {
    "sourcey": {
      "command": "npx",
      "args": ["sourcey", "mcp"]
    }
  }
}

Prompts to try

Example prompts for working with Sourcey documentation generation.

- "Generate API documentation from my openapi.yaml and include code samples in Python, TypeScript, and Go"
- "Build the documentation site and create llms.txt for AI assistant context"
- "Convert my Doxygen XML output into a browsable static documentation site"
- "Add a Markdown guides section to my existing OpenAPI reference docs"
- "Generate Go package documentation from my source code and merge it with the REST API reference"

Troubleshooting Sourcey

'sourcey: command not found' after npm install

Ensure npm global bin directory is in your PATH. Run 'npm config get prefix' to find the location and add '<prefix>/bin' to your PATH. Alternatively, use 'npx sourcey build' instead of the global command.

OpenAPI build fails with schema validation errors

Sourcey validates your OpenAPI spec strictly. Run 'npx @redocly/cli lint openapi.yaml' to identify and fix schema errors before running the build. Common issues include missing 'info' fields, invalid $ref paths, or unsupported OpenAPI 2.x syntax.

Doxygen XML output is not being processed

Run Doxygen with GENERATE_XML=YES in your Doxyfile and point Sourcey at the xml/ output directory. The path in sourcey.config.ts should reference the doxygen XML folder, not the HTML output.

Frequently Asked Questions about Sourcey

What is Sourcey?

Sourcey is a Model Context Protocol (MCP) server that precision documentation from openapi, mcp, doxygen, and markdown guides. static html you own. It connects AI assistants to external tools and data sources through a standardized interface.

How do I install Sourcey?

Follow the installation instructions on the Sourcey GitHub repository. Clone the repo, install dependencies, and add the server config to your AI client.

Which AI clients work with Sourcey?

Sourcey works with all major MCP-compatible AI clients including Claude Desktop, Claude Code, Cursor, VS Code (GitHub Copilot), Windsurf, and Cline.

Is Sourcey free to use?

Yes, Sourcey is open source and available under the AGPL-3.0 license. You can use it freely in both personal and commercial projects.

Browse More Developer Tools MCP Servers

Explore all developer tools servers available in the MCPgee directory. Each server includes setup guides for Claude, Cursor, and VS Code.

Quick Config Preview

{ "mcpServers": { "sourcey": { "command": "npx", "args": ["-y", "sourcey"] } } }

Add this to your claude_desktop_config.json or .cursor/mcp.json

Read the full setup guide →

Ready to use Sourcey?

Browse our complete directory of 33,000+ MCP servers, read setup guides for your editor, and start building with the Model Context Protocol.

33,000+ ServersFree & Open SourceStep-by-Step Guides