ByJG Open Source Docs

com.byjg由 byjg.com 发布官方发布者v0.1.0更新于 Oct 24, 2026

Search the ByJG open source documentation: PHP, DevOps, Helm, JavaScript and AI projects.

已验证Streamable HTTP可网页运行知识与记忆开发者工具

概览

AI 生成的概览

远程 MCP 服务器,让助手对 ByJG 开源文档(PHP、DevOps、Helm、JavaScript、AI 项目)进行语义检索并引用来源页面。

可以做什么
  • 用自然语言问题或精确符号名检索文档段落,可按类别或项目缩小范围
  • 按来源路径获取单个文档页面的完整 Markdown 内容
  • 列出已索引的项目与类别,以及文档和段落数量
适用场景
在使用 MicroOrm、RestServer、Gluo、EasyHAProxy 等 ByJG 库时,希望得到有官方文档依据并附来源链接的回答。也适合先确认哪些 ByJG 项目已有文档。
运行要求
需要一个远程 Streamable HTTP 端点,URL 必须以 /mcp 结尾。公共实例无需认证或 API 密钥,也无需本地运行时或安装软件包。
安装前请注意
服务器会记录每次工具调用,包括查询内容和筛选条件,用于发现文档缺口;日志保留在服务器上,但不要在查询中放入机密信息。自行部署的副本可能改为要求 bearer 令牌。

安装

在 SourceWeft 中

  1. 打开 控制台中的 ByJG Open Source Docs,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Web executable,通过 Streamable HTTP。 远程服务在工作区中配置后即可从网页运行时运行。

交给智能体安装

把这段提示词粘贴到 Claude Code、Codex、Cursor 等智能体,或 SourceWeft 对话中。智能体会读取该服务器的安装指南,先向你展示发布者、端点和登录方式,经你同意后再把它添加到你的客户端。密钥不会写进任何命令。

阅读 https://sourceweft.com/mcp/com.byjg%2Fdocs/install.md,并按其中说明把这个 MCP 服务器接入我的客户端。修改任何配置之前,先告诉我它的发布者、端点和登录方式,等我确认。不要把 API 密钥写进命令或我会提交的文件;问我密钥应从哪里获取。

查看智能体所依据的安装指南

其他 MCP 客户端

把它添加到你客户端的 mcpServers 配置中。

{
  "mcpServers": {
    "byjg-open-source-docs": {
      "type": "http",
      "url": "https://mcpdocs.byjg.com/mcp"
    }
  }
}

README


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

URLhttps://mcpdocs.byjg.com/mcp
TransportStreamable HTTP
AuthenticationNone -- 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:

json
{  "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

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

ToolPurpose
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.

来源:README.md,提交 b445b73

工具

3

search_docs

Search ByJG documentation

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, ...).

输入参数limitquery必填projectcategory

get_document

Read a documentation page

Return the full markdown of one documentation page, addressed by the `source` path reported in a search result (for example `php/micro-orm/active-record.md`). Use it when a search hit is relevant but truncated and you need the whole page.

输入参数source_path必填

list_projects

List documented projects

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.

无需输入参数。

版本历史

1
  1. v0.1.0最新Sep 16, 2026

评分

已满足适用检查项的 90%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通必需25 分
  • 已声明认证方式必需10 分
  • 已列出工具必需15 分
  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分

    请在仓库或注册中心条目中声明许可证。