
Turn any github repo to MCP server, and chat with code or docs
Turn any github repo to MCP server, and chat with code or docs
·
A flexible Model Context Protocol (MCP) server powered by Probe that makes any documentation or codebase searchable by AI assistants.
Chat with code or your docs by simply pointing to a git repo or folder:
npx -y @probelabs/docs-mcp@latest --gitUrl https://github.com/probelabs/probeUse Cases:
The content source (documentation or code) can be pre-built into the package during the npm run build step, or configured dynamically at runtime using local directories or Git repositories. By default, when using a gitUrl without enabling auto-updates, the server downloads a .tar.gz archive for faster startup. Full Git cloning is used only when autoUpdateInterval is greater than 0.
Add to your Claude Desktop configuration file (~/Library/Application Support/Claude/claude_desktop_config.json on macOS):
{
"mcpServers": {
"docs-search": {
"command": "npx",
"args": [
"-y",
"@probelabs/docs-mcp@latest",
"--gitUrl",
"https://github.com/your-org/your-repo",
"--toolName",
"search_docs",
"--toolDescription",
"Search documentation"
]
}
}
}You can configure your MCP client to launch this server using npx. Here are examples of how you might configure a client (syntax may vary based on the specific client):
Example 1: Dynamically Searching a Git Repository (Tyk Docs)
This configuration tells the client to run the latest @probelabs/docs-mcp package using npx, pointing it dynamically to the Tyk documentation repository. The -y argument automatically confirms the npx installation prompt. The --toolName and --toolDescription arguments customize how the search tool appears to the AI assistant.
{
"mcpServers": {
"tyk-docs-search": {
"command": "npx",
"args": [
"-y",
"@probelabs/docs-mcp@latest",
"--gitUrl",
"https://github.com/TykTechnologies/tyk-docs",
"--toolName",
"search_tyk_docs",
"--toolDescription",
"Search Tyk API Management Documentation"
],
"enabled": true
}
}
}Alternatively, some clients might allow specifying the full command directly. You could achieve the same as Example 1 using:
npx -y @probelabs/docs-mcp@latest --gitUrl https://github.com/TykTechnologies/tyk-docs --toolName search_tyk_docs --toolDescription "Search Tyk API Management Documentation"Example 2: Using a Pre-built, Branded MCP Server (e.g., Tyk Package)
If a team publishes a pre-built package containing specific documentation (like @tyk-technologies/docs-mcp), the configuration becomes simpler as the content source and tool details are baked into that package. The -y argument is still recommended for npx.
{
"mcpServers": {
"tyk-official-docs": {
"command": "npx",
"args": [
"-y",
"@tyk-technologies/docs-mcp@latest"
],
"enabled": true
}
}
}This approach is ideal for distributing standardized search experiences for official documentation or codebases. See the "Creating Your Own Pre-built MCP Server" section below.
Here is example on how Tyk team have build own documentation MCP server https://github.com/TykTechnologies/docs-mcp.
Create a docs-mcp.config.json file in the root directory to define the default content source and MCP tool details used during the build and at runtime (unless overridden by CLI arguments or environment variables).
{
"includeDir": "/Users/username/projects/my-project/docs",
"toolName": "search_my_project_docs",
"toolDescription": "Search the documentation for My Project.",
"ignorePatterns": [
"node_modules",
".git",
"build",
"*.log"
]
}{
"gitUrl": "https://github.com/your-org/your-codebase.git",
"gitRef": "develop",
"autoUpdateInterval": 15,
"toolName": "search_codebase",
"toolDescription": "Search the main company codebase.",
"ignorePatterns": [
"*.test.js",
"dist/",
"__snapshots__"
]
}includeDir: (Build/Runtime) Absolute path to a local directory whose contents will be copied to the data directory during build, or used directly at runtime if dataDir is not specified. Use this OR gitUrl.gitUrl: (Build/Runtime) URL of the Git repository. Use this OR includeDir.
autoUpdateInterval is 0 (default), the server attempts to download a .tar.gz archive directly (currently assumes GitHub URL structure: https://github.com/{owner}/{repo}/archive/{ref}.tar.gz). This is faster but doesn't support updates.autoUpdateInterval > 0, the server performs a git clone and enables periodic updates.gitRef: (Build/Runtime) The branch, tag, or commit hash to use from the gitUrl (default: main). Used for both tarball download and Git clone/pull.autoUpdateInterval: (Runtime) Interval in minutes to automatically check for Git updates (default: 0, meaning disabled). Setting this to a value > 0 enables Git cloning and periodic git pull operations. Requires the git command to be available in the system path.dataDir: (Runtime) Path to the directory containing the content to be searched at runtime. Overrides content sourced from includeDir or gitUrl defined in the config file or built into the package. Useful for pointing the server to live data without rebuilding.toolName: (Build/Runtime) The name of the MCP tool exposed by the server (default: search_docs). Choose a descriptive name relevant to the content.toolDescription: (Build/Runtime) The description of the MCP tool shown to AI assistants (default: "Search documentation using the probe search engine.").ignorePatterns: (Build/Runtime) An array of glob patterns.enableBuildCleanup: (Build) If true (default), removes common binary/media files (images, videos, archives, etc.) and files larger than 100KB from the data directory after the build step. Set to false to disable this cleanup.
includeDir during build: Files matching these patterns are excluded when copying to data. .gitignore rules are also respected.gitUrl or dataDir at runtime: Files matching these patterns within the data directory are ignored by the search indexer.Precedence:
--dataDir, --gitUrl, etc.) and Environment Variables (DATA_DIR, GIT_URL, etc.) override all other settings. CLI arguments take precedence over Environment Variables.docs-mcp.config.json (includeDir, gitUrl, toolName, etc.) define defaults used during npm run build and also serve as runtime defaults if not overridden.toolName: 'search_docs', autoUpdateInterval: 5).Note: If both includeDir and gitUrl are provided in the same configuration source (e.g., both in the config file, or both as CLI args), gitUrl takes precedence.
You can use this project as a template to create and publish your own npm package with documentation or code pre-built into it. This provides a zero-configuration experience for users (like Example 2 above).
docs-mcp.config.json: Define the includeDir or gitUrl pointing to your content source. Set the default toolName and toolDescription.package.json: Change the name (e.g., @my-org/my-docs-mcp), version, description, etc.npm run build. This clones/copies your content into the data directory and makes the package ready.npm publish (you'll need npm authentication configured).Now, users can run your specific documentation server easily: npx @my-org/my-docs-mcp@latest.
(The previous "Running", "Dynamic Configuration at Runtime", and "Environment Variables" sections have been removed as npx usage with arguments within client configurations is now the primary documented method.)
This MCP server exposes a search tool to connected AI assistants via the Model Context Protocol. The tool's name and description are configurable (see Configuration section). It searches the content within the currently active data directory (determined by build settings, config file, CLI args, or environment variables).
Tool Parameters:
query: A natural language query or keywords describing what to search for (e.g., "how to configure the gateway", "database connection example", "user authentication"). The server uses Probe's search capabilities to find relevant content. (Required)page: The page number for results when dealing with many matches. Defaults to 1 if omitted. (Optional)Example Tool Call (using search_tyk_docs from Usage Example 1):
{
"tool_name": "search_tyk_docs",
"arguments": {
"query": "gateway rate limiting",
"page": 1 // Requesting the first page
}
}Example Tool Call (using the tool from the @tyk/docs-mcp package):
Assuming the pre-built package @tyk/docs-mcp defined its tool name as search_tyk_official_docs:
{
"tool_name": "search_tyk_official_docs",
"arguments": {
"query": "dashboard api access",
"page": 2 // Requesting the second page
}
}(The previous "Publishing as an npm Package" section has been replaced by the "Creating Your Own Pre-built MCP Server" section above.)
To install Docs MCP Server for Claude Desktop automatically via Smithery:
npx -y @smithery/cli install @probelabs/docs-mcp --client claudeThis project includes a reusable GitHub Actions workflow that makes releasing MCP servers to NPM incredibly simple. You can use this workflow in any project to automatically build and publish your MCP server when you push a git tag.
To use this automated release system in your own project, create a single file .github/workflows/release.yml:
name: Release MCP
on:
push:
tags:
- 'v*'
jobs:
release:
uses: probelabs/docs-mcp/.github/workflows/release-mcp.yml@main
with:
package-name: '@yourorg/your-mcp-server'
package-description: 'Your MCP Server Description'
include-folders: 'src,data,bin' # Folders to include in the package
include-files: '*.json,*.md' # File patterns to include
secrets:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}Then simply create a git tag to trigger a release:
git tag v1.0.0
git push origin v1.0.0| Parameter | Required | Default | Description |
|---|---|---|---|
package-name | Yes | - | NPM package name (e.g., @org/my-mcp) |
package-description | No | MCP Server | Package description |
entry-point | No | src/index.js | Main entry file path |
include-folders | No | src,data,bin | Comma-separated list of folders to include |
include-files | No | *.json,*.md,LICENSE | Comma-separated list of file patterns |
dependencies | No | {} | Additional dependencies as JSON string |
build-command | No | - | Build command to run before publishing |
node-version | No | 18 | Node.js version to use |
jobs:
release:
uses: probelabs/docs-mcp/.github/workflows/release-mcp.yml@main
with:
package-name: '@myorg/simple-mcp'
secrets:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}jobs:
release:
uses: probelabs/docs-mcp/.github/workflows/release-mcp.yml@main
with:
package-name: '@myorg/custom-mcp'
dependencies: '{"lodash": "^4.17.21", "dotenv": "^16.0.0"}'
secrets:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}jobs:
release:
uses: probelabs/docs-mcp/.github/workflows/release-mcp.yml@main
with:
package-name: '@myorg/built-mcp'
build-command: 'npm run build && npm run prepare-data'
include-folders: 'dist,assets'
secrets:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}NPM_TOKEN secret to your GitHub repository (Settings → Secrets → Actions)The workflow automatically:
v1.0.0 → 1.0.0)package.json with MCP dependenciesMIT
Pick your client and paste the snippet. Each one is the same server, written the way that client expects it.
claude mcp add docs-search -- npx -y @probelabs/docs-mcp@latest --gitUrl https://github.com/your-org/your-repo --toolName search_docs --toolDescription "Search documentation"{
"mcpServers": {
"docs-search": {
"args": [
"-y",
"@probelabs/docs-mcp@latest",
"--gitUrl",
"https://github.com/your-org/your-repo",
"--toolName",
"search_docs",
"--toolDescription",
"Search documentation"
],
"command": "npx"
}
}
}code --add-mcp '{"name":"docs-search","args":["-y","@probelabs/docs-mcp@latest","--gitUrl","https://github.com/your-org/your-repo","--toolName","search_docs","--toolDescription","Search documentation"],"command":"npx"}'[mcp_servers.docs-search]
command = "npx"
args = ["-y", "@probelabs/docs-mcp@latest", "--gitUrl", "https://github.com/your-org/your-repo", "--toolName", "search_docs", "--toolDescription", "Search documentation"]Runs locally on your device. Your client starts the server itself, so nothing has to be hosted.
Paste this prompt into your agent. It reads this page and does the setup for you.
Read https://aiagentslisting.com/mcp/docs-mcp-server to learn what the "Docs MCP Server" MCP server does and how to install it. Add it to my coding agent's MCP configuration as documented on that page, then confirm the server connects and list the tools it exposes.Agents can also browse this directory over MCP at https://aiagentslisting.com/api/mcp
npx -y @probelabs/docs-mcp@latest --gitUrl https://github.com/probelabs/probe
npx -y @probelabs/docs-mcp@latest --gitUrl https://github.com/TykTechnologies/tyk-docs --toolName search_tyk_docs --toolDescription "Search Tyk API Management Documentation"
npx -y @smithery/cli install @probelabs/docs-mcp --client claudeThis server runs locally, so we can't read its tool list over the web yet.
We could not run this server: its npm package has not answered in our offline sandbox, which usually means it needs an API key or other configuration to start. The four checks that need a live server are left out, and the grade tops out at B until we can read its tools.
Maintain this server? Claiming proves you own the listing and earns the last 4 points.
Claim this listingPaste this line near the top of your repository's README. The badge always renders the current score.
[](https://aiagentslisting.com/mcp/docs-mcp-server)Nothing comparable is listed yet.
v0.2Release notesv0.1.1Release notesv0.1.0-rc2Release notesv0.1.0-rc1Release notesConnect to the AI Agents Listing MCP server at https://aiagentslisting.com/api/mcp using the HTTP transport and complete the sign-in when it asks. Then call the submit_review tool for the listing "docs-mcp-server" with a rating from 1 to 5 and a short note on what worked and what did not.No reviews yet
Be the first to share your experience with this tool.
One email a week. New agents, MCP servers and skills, and what is actually getting traction.