ByJG Open Source Docs

Name: ByJG Open Source Docs
Author: byjg.com

远程服务

opensource.byjg.com开发工具04 天前更新

关于 ByJG Open Source Docs

ByJG Docs MCP Server 为 AI 助手提供 ByJG 开源项目文档的语义搜索，并可引用来源页面。它面向使用 ByJG 库的用户，支持检索段落和读取完整页面。

它通过 Streamable HTTP 向 MCP 客户端提供文档搜索、页面读取和项目清单工具，地址为 https://mcpdocs.byjg.com/mcp。公共端点无需身份验证。

远程服务无需本地安装。选择你使用的客户端，复制配置或使用一键安装。

服务地址https://mcpdocs.byjg.com/mcp

一键复制安装命令

Claude CodeTerminalclaude mcp add --transport http com-byjg-docs https://mcpdocs.byjg.com/mcp

Cursor.cursor/mcp.json{"mcpServers":{"com-byjg-docs":{"type":"http","url":"https://mcpdocs.byjg.com/mcp"}}}在 Cursor 中打开

VS Code.vscode/mcp.json{"servers":{"com-byjg-docs":{"type":"http","url":"https://mcpdocs.byjg.com/mcp"}}}在 VS Code 中打开

Claude Desktopclaude_desktop_config.json{"mcpServers":{"com-byjg-docs":{"type":"http","url":"https://mcpdocs.byjg.com/mcp"}}}

Windsurf~/.codeium/windsurf/mcp_config.json{"mcpServers":{"com-byjg-docs":{"serverUrl":"https://mcpdocs.byjg.com/mcp"}}}

命令在终端中运行；JSON 粘贴到对应客户端的 MCP 配置后重启。需要授权的服务会在首次连接时提示登录。

一个 MCP 服务，为 AI 助手提供 ByJG 所有开源项目文档的语义搜索功能——这些内容也发布在 opensource.byjg.com。

连接助手后，它便可以回答有关 ByJG 库（MicroOrm、RestServer、Gluo、EasyHAProxy 等）的疑问，并引用每个答案所依据的文档页面。

URL 必须以 /mcp 结尾。

大多数客户端都接受这种格式；具体的文件和键因客户端而异：

{
  "mcpServers": {
    "byjg-docs": {
      "url": "https://mcpdocs.byjg.com/mcp"
    }
  }
}

要运行自己的副本？也可以要求提供 bearer token—— 请参阅身份验证。

一键安装徽章会将端点直接交给客户端，然后客户端会要求你确认；其他方式则是在客户端页面中手动配置。连接问题请参阅：故障排除。

这两种方式都不会从注册表安装。该服务已在官方 MCP Registry 中发布，名称为 com.byjg/docs，供发现和验证来源之用：请参阅 MCP Registry 条目。

工具	用途
`search_docs(query, limit, category, project)`	排序后的段落，每个段落都附有其公开 URL
`get_document(source_path)`	获取单个页面的完整 Markdown
`list_projects()`	查看已索引内容清单

query 接受自然语言（“如何将表映射到类”）或确切的符号名称（TableAttribute）——两者都可以。详见工具详情。