ZKshare について
zkshare-mcpは、ZKshare向けのstdio MCPサーバーで、ツール呼び出しをcontext APIに転送します。ZKshareのAPIキーを設定したMCPクライアントを対象とし、公式MCP Registryプレビューでの検出用メタデータも含みます。
主な機能
- 01context APIへの呼び出し転送
- 02ZKshare APIキーによる認証
- 03カスタムAPI URLの設定
- 04npx経由での実行
活用シーン
- 01IDEをZKshareに接続
- 02MCPクライアントからZKshareのcontextツールを利用
MCP 対応
stdio MCPサーバーとして動作し、設定されたAPIキーを使ってツール呼び出しをZKshareのHTTPS /api/v1/contextエンドポイントに転送します。
設定
ローカルサーバーの設定はどのクライアントでも共通です。コピーしてクライアントの MCP 設定ファイルに貼り付けてください。
npx -y zkshare-mcpZKSHARE_API_KEYシークレットZKshare API key (zk_live_…). Create one at zkshare.io/api-key — required for POST /api/v1/context.ZKSHARE_API_URLAPI origin including scheme; omit for production (https://zkshare.io). Use http://localhost:3000 only when self-hosting.ローカルサーバーにはマシン上の実行環境(Node.js 18 以上など)が必要です。設定ファイルの場所はクライアントごとに異なります。
ツール
6掲載時のツール一覧 · 2 週間前に更新
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
| value | string | はい | |
| user_id | string | いいえ | 論理スコープ(HTTPS の呼び出し時に使用するものと同じ文字列)です。省略すると "" になります。 |
| fact_key | string | はい |
詳細
zkshare-mcp
npm で公開されています。ZKshare 用の Stdio Model Context Protocol サーバーです。API キーを使って、ツール呼び出しを POST /api/v1/context に転送します。
レジストリ名: 公式の Model Context Protocol Registry プレビューにある io.github.sp0oby/zkshare(package.json の検証フィールド mcpName は、server.json の name フィールドと同一にする必要があります)。
MCP Registry(registry.modelcontextprotocol.io)
ZKshare は、公式 MCP Registry プレビューを通じた検出に参加(またはその準備)しています。メタデータはこのパッケージと同じ場所にある server.json にあり、実行可能な成果物は npm に置かれます。
npm に zkshare-mcp(例:v1.0.0)があるだけでは不十分です。レジストリは tarball 内の package.json をチェックし、mcpName を確認します。このフィールドは v1.0.1 用にリポジトリへ追加されました。npm に 1.0.1 が公開されるまでは、検証で mcp-publisher publish が失敗する場合があります。すでに npm を使っているユーザーは、引き続き npx -y [email protected] を変更せずに使用できます。
一度限りの前提条件
zkshare-mcpの公開権限がある npm アカウント。- GitHub デバイスログインを使用する場合、
io.github.sp0oby/…名前空間と一致する GitHub アカウント(sp0oby)。 - パブリッシャー CLI をインストールします(クイックスタート)。
公開手順(メンテナー向け)
- バージョンを揃える —
package.json、src/version.tsの"version"とserver.jsonのversionフィールドをまとめて更新します。 - ビルドして npm に公開する — このディレクトリで実行します。
pnpm install && pnpm run buildnpm publish --access public(prepublishOnlyによってpnpm run buildが実行されます)。
- レジストリ —
mcp-publisherをインストールし、packages/zkshare-mcp/から実行します。mcp-publisher login github— デバイスフローです。GitHub ユーザーは名前空間(sp0oby)と一致する必要があります。mcp-publisher publish—server.jsonをアップロードします(npm のみを意図的に公開する場合は省略してください)。
公開後の確認
curl "https://registry.modelcontextprotocol.io/v0.1/servers?search=io.github.sp0oby/zkshare"
mcp-publisher で検証エラーが発生する場合は、description が 100 文字以下であることを確認してください(レジストリの JSON スキーマ)。
代替の名前空間
io.github.sp0oby の代わりに DNS または別の認証方法を使用するには、mcpName と server.json → name を変更し、所有権の検証をやり直してください。認証に関するレジストリのドキュメントと、同じドキュメントツリー内の DNS に関する説明を参照してください。
使用方法(リポジトリのクローン不要)
Node.js ≥ 18 が必要です。
npx -y zkshare-mcp
通常は IDE がこれを実行します。MCP 設定で環境変数を設定してください。
環境変数
| 変数 | 必須 | 説明 |
|---|---|---|
ZKSHARE_API_KEY | はい | zkshare.io/api-key で取得します |
ZKSHARE_API_URL | いいえ | デフォルトは https://zkshare.io です。セルフホストの API の場合に限り、http://localhost:3000 を使用してください。 |
Cursor ~/.cursor/mcp.json
{
"mcpServers": {
"zkshare": {
"command": "npx",
"args": ["-y", "zkshare-mcp"],
"env": {
"ZKSHARE_API_KEY": "zk_live_YOUR_KEY_HERE",
"ZKSHARE_API_URL": "https://zkshare.io"
}
}
}
}
Windows では、npx は Node に同梱されています(npx.cmd)。
zkShare リポジトリで開発する
pnpm install
pnpm mcp
ソース:src/cli.ts。メンテナーがリリース時にバージョンを更新できるよう、package.json と src/version.ts にバージョンが重複して記載されています。
コメント
AI アプリケーションが外部のツールやデータソースに統一的な方法で接続するためのオープンなプロトコルです。クライアントはモデルとの対話を担い、MCP サーバーはツール・リソース・プロンプトテンプレートを提供します。標準メッセージでやり取りするため、1 つのサーバーを複数のクライアントで再利用できます。