ZKshare

zkshare-mcp

已发布到 npm。面向 ZKshare 的 Stdio Model Context Protocol 服务 — 使用你的 API 密钥，将工具调用转发到 POST /api/v1/context。

注册表名称： 官方 Model Context Protocol 注册表预览版中的 io.github.sp0oby/zkshare（package.json 中的验证字段 mcpName 必须与 server.json 中的 name 字段保持一致）。

MCP 注册表（registry.modelcontextprotocol.io）

ZKshare 正在参与（或为通过 **官方 MCP 注册表**预览版进行发现做准备）。元数据位于此软件包旁的 server.json 中；可运行的制品仍发布在 npm 上。

将 zkshare-mcp 发布到 npm（例如 v1.0.0）只是其中一部分：注册表会检查 tarball 中 package.json 的 mcpName — 该字段已加入仓库，适用于 v1.0.1。在 1.0.1 发布到 npm 之前，mcp-publisher publish 可能无法通过验证。对于已在 npm 上使用该软件包的用户，npx -y [email protected] 仍可照常运行。

一次性前提条件

1. 拥有 zkshare-mcp 发布权限的 npm 账户。
2. 使用 GitHub 设备登录时，与 io.github.sp0oby/… 命名空间匹配的 GitHub 账户（sp0oby）。
3. 安装发布者 CLI（快速入门）。

发布流程（维护者）

1. 统一版本 — 同时更新 package.json 中的 "version"、src/version.ts 和 server.json 中的 version 字段。
2. 构建并发布到 npm — 在此目录中运行：
   • pnpm install && pnpm run build
   • npm publish --access public（prepublishOnly 会运行 pnpm run build）。
3. 注册表 — 安装 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 schema 的限制）。

其他命名空间

如需改用 DNS 或其他身份验证方式，而非 io.github.sp0oby — 更改 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 中重复定义的版本号。