ByJG Open Source Docs README
The full upstream README, mirrored here for reference. Install config, tool schemas, adoption signals, and an original overview live on the ByJG Open Source Docs listing page.
sidebar_key: mcpserver-byjg-docs tags: [ai, python, docker]
ByJG Docs MCP Server
An MCP server that gives AI assistants semantic search over the documentation of every ByJG open source project -- the same content published at opensource.byjg.com.
Connect your assistant and it can answer questions about the ByJG libraries (MicroOrm, RestServer, Gluo, EasyHAProxy, ...) and cite the documentation page each answer came from.
Endpoint
| URL | https://mcpdocs.byjg.com/mcp |
| Transport | Streamable HTTP |
| Authentication | None -- the documentation is public, so no token is needed |
The URL must end in /mcp.
Most clients accept this shape; the exact file and keys vary per client:
Running your own copy? It can require a bearer token instead -- see Authentication.
Add it to your client
| Client | Setup | One-click |
|---|---|---|
| Claude Code (CLI) | instructions | |
| Claude Desktop | instructions | |
| Codex CLI | instructions | |
| Gemini CLI | instructions | |
| Cursor | instructions |  |
| VS Code | instructions |  |
| VS Code Insiders | instructions |  |
| Visual Studio |  | |
| JetBrains IDEs | instructions | |
| Goose |  | |
| LM Studio |  |
The one-click badges hand the endpoint straight to the client, which then asks you to confirm; everything else is the manual configuration on the client page. Connection problems: Troubleshooting.
Neither path installs from a registry. The server is published in the
official MCP Registry as com.byjg/docs, for discovery and provenance: see
The MCP Registry entry.
Tools
| Tool | Purpose |
|---|---|
search_docs(query, limit, category, project) | Ranked passages, each with its public URL |
get_document(source_path) | Full markdown of one page |
list_projects() | Inventory of what is indexed |
query accepts natural language ("how do I map a table to a class") or an
exact symbol name (TableAttribute) -- both work. See
the tools in detail.
Privacy
The server records each tool call -- the query, its filters and how well the documentation matched -- to find what the docs do not cover yet. The log stays on the server and is not shared. Do not put secrets in a query.
Development
To run the server yourself, self-host it, or change the code, see Development.