ByJG Open Source Docs について
ByJG Docs MCP Serverは、ByJGのオープンソースプロジェクトのドキュメントをAIアシスタントが検索し、出典ページを示せるようにします。ByJGライブラリの利用者向けに、検索結果とページ全体のMarkdownを提供します。
主な機能
- 01ドキュメントのセマンティック検索
- 02検索結果に出典URLを表示
- 03ページ全体のMarkdown取得
- 04インデックス済みプロジェクトの一覧
活用シーン
- 01ByJGライブラリの使い方を調べる
- 02TableAttributeなどのシンボルを検索
- 03ドキュメントページ全体を読む
MCP 対応
Streamable HTTPで、ドキュメント検索、ページ取得、プロジェクト一覧のツールをMCPクライアントに提供します。公開エンドポイントは認証不要です。
設定
リモートサーバーはインストール不要です。クライアントを選んで設定をコピーするか、ワンクリックで導入できます。
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"}}}Cursor で開く{"servers":{"com-byjg-docs":{"type":"http","url":"https://mcpdocs.byjg.com/mcp"}}}VS Code で開く{"mcpServers":{"com-byjg-docs":{"type":"http","url":"https://mcpdocs.byjg.com/mcp"}}}{"mcpServers":{"com-byjg-docs":{"serverUrl":"https://mcpdocs.byjg.com/mcp"}}}コマンドはターミナルで実行し、JSON は各クライアントの MCP 設定に貼り付けて再起動します。認可が必要なサーバーは初回接続時にログインを求めます。
ツール
3| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
| limit | integer | いいえ | |
| query | string | はい | |
| project | any | いいえ | |
| category | any | いいえ |
詳細
sidebar_key: mcpserver-byjg-docs tags: [ai, python, docker]
ByJG Docs MCP サーバー
AI アシスタントが、すべての ByJG オープンソースプロジェクトのドキュメントをセマンティック検索できるようにするMCPサーバーです。対象は、opensource.byjg.comで公開されているものと同じコンテンツです。
アシスタントを接続すると、ByJG ライブラリ(MicroOrm、RestServer、Gluo、EasyHAProxy など)について質問し、各回答の根拠となったドキュメントページを引用できます。
エンドポイント
| URL | https://mcpdocs.byjg.com/mcp |
| トランスポート | Streamable HTTP |
| 認証 | なし。ドキュメントは公開されているため、トークンは不要です |
URL の末尾は /mcp にする必要があります。
ほとんどのクライアントでこの形式を使用できます。ファイル名やキーはクライアントによって異なります。
{
"mcpServers": {
"byjg-docs": {
"url": "https://mcpdocs.byjg.com/mcp"
}
}
}
独自のコピーを実行していますか?その場合、代わりにベアラートークンが必要になることがあります。認証を参照してください。
クライアントに追加する
| クライアント | 設定方法 | ワンクリック |
|---|---|---|
| Claude Code (CLI) | 手順 | |
| Claude Desktop | 手順 | |
| Codex CLI | 手順 | |
| GitHub Copilot CLI | 手順 | |
| Gemini CLI | 手順 | |
| OpenCode | 手順 | |
| Cursor | 手順 | |
| VS Code | 手順 | |
| VS Code Insiders | 手順 | |
| Visual Studio | ||
| JetBrains IDEs | 手順 | |
| Goose | ||
| LM Studio |
ワンクリックバッジを使うと、エンドポイントがクライアントに直接渡され、クライアントで確認を求められます。それ以外は、クライアントページに記載されている手動設定です。接続に問題がある場合は、トラブルシューティングを参照してください。
どちらの方法でも、レジストリからインストールすることはありません。このサーバーは、検出と出所の確認のため、公式 MCP Registry に com.byjg/docs として登録されています。MCP Registry のエントリーを参照してください。
ツール
| ツール | 用途 |
|---|---|
search_docs(query, limit, category, project) | 公開 URL 付きの、関連度順の文章 |
get_document(source_path) | 1 ページ分の Markdown 全文 |
list_projects() | インデックス済みの項目一覧 |
query には、自然言語(「テーブルをクラスにマッピングする方法」など)も、正確なシンボル名(TableAttribute)も指定でき、どちらも機能します。
ツールの詳細をご覧ください。
プライバシー
サーバーは各ツール呼び出し(クエリ、そのフィルター、ドキュメントとの一致度)を記録し、まだドキュメントでカバーされていない内容を把握します。ログはサーバー上に保存され、共有されません。クエリに秘密情報を含めないでください。
開発
サーバーを自分で実行する方法、セルフホストする方法、コードを変更する方法については、開発をご覧ください。
コメント
AI アプリケーションが外部のツールやデータソースに統一的な方法で接続するためのオープンなプロトコルです。クライアントはモデルとの対話を担い、MCP サーバーはツール・リソース・プロンプトテンプレートを提供します。標準メッセージでやり取りするため、1 つのサーバーを複数のクライアントで再利用できます。