ByJG Open Source Docs
RemoteAbout ByJG Open Source Docs
ByJG Docs MCP Server lets AI assistants search documentation for ByJG open-source projects and cite the source page. It is for users working with ByJG libraries and provides both ranked passages and full-page markdown.
Key features
- 01Semantic documentation search
- 02Source URLs for search results
- 03Retrieve full-page Markdown
- 04List indexed projects
Use cases
- 01Find guidance for a ByJG library
- 02Look up an exact symbol such as TableAttribute
- 03Read a complete documentation page
MCP support
It exposes documentation search, page retrieval, and project inventory tools to MCP clients over Streamable HTTP at https://mcpdocs.byjg.com/mcp. The public endpoint requires no authentication.
Configuration
Remote servers need no local install. Pick your client, then copy the config or install in one click.
https://mcpdocs.byjg.com/mcpclaude mcp add --transport http com-byjg-docs https://mcpdocs.byjg.com/mcp{"mcpServers":{"com-byjg-docs":{"type":"http","url":"https://mcpdocs.byjg.com/mcp"}}}Open in Cursor{"servers":{"com-byjg-docs":{"type":"http","url":"https://mcpdocs.byjg.com/mcp"}}}Open in VS Code{"mcpServers":{"com-byjg-docs":{"type":"http","url":"https://mcpdocs.byjg.com/mcp"}}}{"mcpServers":{"com-byjg-docs":{"serverUrl":"https://mcpdocs.byjg.com/mcp"}}}Run commands in a terminal; paste JSON into the client’s MCP config and restart. Servers that need sign-in will prompt on first connect.
Tools
3| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | No | |
| query | string | Yes | |
| project | any | No | |
| category | any | No |
Details
From the project READMEsidebar_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:
{
"mcpServers": {
"byjg-docs": {
"url": "https://mcpdocs.byjg.com/mcp"
}
}
}
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 | |
| GitHub Copilot CLI | instructions | |
| Gemini CLI | instructions | |
| OpenCode | 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.
Comments
New to MCP?
From what the protocol is to installing your first server, these answers cover most first questions.
An open protocol that defines how AI applications connect to external tools and data in a uniform way. Clients talk to the model; MCP servers provide tools, resources and prompt templates. They exchange standard messages, so one server can be reused by many clients.