byjg-docs-mcp
OfficialServer Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| BYJG_DOCS_TRANSPORT | No | Transport protocol to use (e.g., 'stdio' or 'http'). Defaults to 'http' when running as a service. | http |
| BYJG_DOCS_AUTH_TOKEN | No | Bearer token for authenticating MCP clients when running as a service. Generate with `openssl rand -hex 32`. | |
| BYJG_DOCS_PUBLIC_URL | No | Public base URL of the MCP service, used for webhook callbacks and health check. | |
| BYJG_DOCS_WEBHOOK_SECRET | No | Secret to verify GitHub webhook requests. Generate with `openssl rand -hex 32`. |
Instructions
Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.
This server publishes no instructions, or was last inspected before Glama recorded them.
Capabilities
Features and capabilities supported by this server
Protocol revision2025-11-25
| Capability | Details |
|---|---|
| tools | {
"listChanged": false
} |
| prompts | {
"listChanged": false
} |
| resources | {
"subscribe": false,
"listChanged": false
} |
| experimental | {} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| search_docsA | Search the ByJG open source documentation and return the most relevant passages, each with its public URL. Combines semantic and keyword matching, so both natural-language questions ('how do I map a table to a class') and exact symbol names ('TableAttribute') work. Optionally narrow to a category (php, devops, js, ai, helm) or a project (micro-orm, restserver, docker-easy-haproxy, ...). |
| get_documentA | Return the full markdown of one documentation page, addressed by the |
| list_projectsA | Inventory of everything indexed, grouped by category and project, with document and passage counts. Use it to discover which ByJG libraries have documentation before searching. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
TDQS
Scored across 3 tools
Each tool has a clearly distinct role: search_docs finds relevant passages, get_document retrieves a full page, and list_projects provides an inventory. There is no functional overlap or ambiguity between them.
All tool names follow a consistent verb_noun snake_case pattern: search_docs, get_document, list_projects. The naming is predictable and easy for an agent to infer.
Three tools is well-scoped for a documentation MCP server: discover, search, and retrieve. Each tool earns its place with no redundancy or unnecessary surface area.
The tool set covers the full documentation workflow: list_projects provides the inventory, search_docs finds relevant content, and get_document retrieves full pages. There are no obvious missing operations for the stated purpose.