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 分

    請在儲存庫或註冊中心條目中宣告授權條款。