briefroom

@briefroom/mcp

日本語版 README: README.ja.md

briefroom stdio MCP サーバー — briefroom CLI を Claude Code、Codex、Cursor などのエージェントに公開し、シェルを自ら起動することなく HTML をデプロイしたり、レビュアーのコメントを取得したりできるようにします。

• 1 回の呼び出しでデプロイ — ローカルディレクトリを zip 化してアップロードし、共有 URL を取得します。
• レビュアーのフィードバックを取得 — ブラウザーからコメントを取得し、AI エージェントがすぐに使える Markdown 形式にします。
• ルームを一覧表示 — 既存のデプロイを共有 URL とともに列挙します。
• 自分だけが見られるようにする — サインイン中の自分だけが開けるプライベートルームに直接デプロイします。

Claude Code に追加する（1 コマンド）

claude mcp add briefroom -- npx -y @briefroom/mcp

環境に BRIEFROOM_TOKEN を設定する（briefroom.net/dashboard/settings/tokens で PAT を作成してください）か、npx @briefroom/cli login を一度実行して OS のキーチェーンに保存します。

エージェントに提供する機能

ツール	機能
deploy_html	ローカルディレクトリを zip 化して briefroom にアップロードします。共有 URL を返します。
get_feedback	共有 URL のレビュアーコメントを、AI エージェントがすぐに使える Markdown（デフォルト）または JSON 形式で取得します。
list_deployments	現在の PAT が所有するルームを、最新のデプロイおよび共有 URL とともに一覧表示します。

内部では、各ツールが子プロセスとして @briefroom/cli を実行します（process.execPath → node <cli>/dist/index.js）。そのため、動作は CLI と同一で、両パッケージはともに進化します。

インストール

npm i -g @briefroom/mcp
# or use it via npx (recommended for .mcp.json)

設定

設定ファイルの場所と env の展開方法はクライアントごとに異なります。お使いのクライアントに該当する項目を選んでください。

Claude Code

プロジェクトのルートに .mcp.json を配置します。Claude Code は起動元シェルの環境変数を使って ${VAR} を展開します。

{
  "mcpServers": {
    "briefroom": {
      "command": "npx",
      "args": ["-y", "@briefroom/mcp"],
      "env": {
        "BRIEFROOM_TOKEN": "${BRIEFROOM_TOKEN}"
      }
    }
  }
}

または、Claude Code CLI から登録します。

claude mcp add briefroom -- npx -y @briefroom/mcp

Codex CLI

Codex は ~/.codex/config.toml から MCP サーバーの定義を読み込みます（Codex CLI のドキュメントを参照してください）。

[mcp_servers.briefroom]
command = "npx"
args = ["-y", "@briefroom/mcp"]
env = { BRIEFROOM_TOKEN = "hak_your_pat_here" }

または、env ブロックを省略し、Codex を起動したシェルから MCP プロセスに BRIEFROOM_TOKEN を引き継がせます。

Cursor

Cursor は MCP 設定の env ブロック内で ${VAR} を展開しないため、PAT の受け渡し方法をあらかじめ決める必要があります。以下の順におすすめします。

オプション A — PAT をリテラル値として指定するユーザー共通設定（PAT をリポジトリに含めずに済みます）：

~/.cursor/mcp.json:

{
  "mcpServers": {
    "briefroom": {
      "command": "npx",
      "args": ["-y", "@briefroom/mcp"],
      "env": { "BRIEFROOM_TOKEN": "hak_your_pat_here" }
    }
  }
}

このファイルはホームディレクトリにあるため、プロジェクトの git 履歴に含まれることはありません。

オプション B — 親シェルから引き継ぐ（設定ファイルに PAT を記載しません）：

env ブロックを含めず、~/.cursor/mcp.json またはプロジェクトの .cursor/mcp.json に設定します。

{
  "mcpServers": {
    "briefroom": {
      "command": "npx",
      "args": ["-y", "@briefroom/mcp"]
    }
  }
}

env を省略すると、MCP プロセスはシェルの環境変数を引き継ぎます。npx @briefroom/cli login を実行済みの場合、CLI は OS のキーチェーンから PAT を読み込みます。または、BRIEFROOM_TOKEN=hak_... をエクスポートしたシェルから Cursor を起動してください。

おすすめしません — PAT をリテラル値として記載するプロジェクトの .cursor/mcp.json：

プロジェクトの .cursor/mcp.json に PAT をリテラル値として記載する必要がある場合は、そのファイルを .gitignore に追加し、決してコミットしないでください。公開リポジトリでの PAT 漏えいはよく知られたインシデントの類型です。上記のオプション A または B をおすすめします。誤ってコミットした場合は、briefroom.net/dashboard/settings/tokens で PAT をローテーションしてください。

その他の stdio-MCP クライアント（Cline / Roo Code / Continue / …）

上記の設定はそのまま使えますが、導入前に ${VAR} の展開方法と、PAT をファイルに記載する場合の安全性について、お使いのクライアントのドキュメントを確認してください。「ユーザー共通のファイル、または環境変数の継承を使う」という優先順位は同じです。

認証

2 つの方法があります。環境に合った方法を選んでください。

1. BRIEFROOM_TOKEN 環境変数（.mcp.json におすすめ）：briefroom.net/dashboard/settings/tokens で PAT を作成し、上記の env ブロックで渡します。
2. OS のキーチェーン（ローカル開発におすすめ）：npx @briefroom/cli login を一度実行します。MCP サーバーは同じ認証情報を自動的に取得します。

両方が設定されている場合、BRIEFROOM_TOKEN がキーチェーンより優先されます。

キーチェーンに保存されたログイン情報は、発行された API オリジンに紐付けられ、別のオリジンに送信されることはありません。BRIEFROOM_API_URL（開発環境／ステージング環境）を設定する場合は、npx @briefroom/cli login --api-url <url> でそのオリジンにログインするか、BRIEFROOM_TOKEN を渡してください。BRIEFROOM_TOKEN は https 経由でのみ送信されます（localhost の場合に限り、通常の http でも送信されます）。

get_feedback は認証情報なしでも動作します。共有 URL のコメントは公開 API です。認証により、所有者のみが利用できるフィールドにアクセスできます。

設定リファレンス

環境変数	用途	デフォルト
BRIEFROOM_TOKEN	パーソナルアクセストークン。キーチェーンの検索をスキップします。	（未設定）
BRIEFROOM_API_URL	CLI の接続先バックエンドを変更します（開発環境／ステージング環境）。	https://briefroom.net

ツールリファレンス

deploy_html

{
  "path": "./mockups",        // required — directory to deploy
  "room": "demo-a",           // optional — room slug: ascii identifier of the room to redeploy into
  "name": "企画書 v2",         // optional — room display name, 1-100 chars, any language
  "expires": "7d",            // optional — "24h" | "7d" | "30d" | "90d" | "never" (Free: 24h / 7d only, private rooms exempt; also updates the existing link on redeploy)
  "new": false,               // optional — start a brand new room
  "password": "s3cret",       // optional — password-protect the link (Pro+ plans; passed to the CLI via env, never argv)
  "visibility": "unlisted",   // optional — "unlisted" | "password_protected" | "email_invite_only"; "unlisted" clears an existing password
  "private": false,           // optional — true is shorthand for visibility "email_invite_only": only you, signed in, can open the room
  "allow_comments": true,     // optional — false hides the comment sidebar (viewers see the page + header only); every plan
  "display_mode": "review"    // optional — "review" (header + comment sidebar) | "live" (chrome-less full-screen page); every plan
}

CLI の JSON（share_url、room_id、version_number、visibility、allow_comments、 display_mode、…）をそのまま返します。

再デプロイでは、expires／password／visibility／allow_comments／display_mode は、 明示的に渡した場合にのみ、既存の共有リンク（同じ URL）に適用されます。設定を変更しない場合は、そのフィールドを省略してください。

混同しやすい 3 つの識別子：

フィールド	内容
name	ダッシュボードとビューアーに表示される名前です。任意の言語を使用できます。初回デプロイ時に設定します。再デプロイ時は、明示的に渡した場合にのみルーム名が更新されます（現在の名前を維持するには省略してください）。
room	ルームのスラッグです。既存のルームを見つけて再デプロイするためだけに使用する、ASCII のケバブケース形式の識別子です。共有 URL の一部にはなりません。
share URL	ランダムなトークン（/s/<token>）を使って常に自動発行されます。name や room から生成されるものではありません。

get_feedback

{
  "share": "https://briefroom.net/s/aB3xQ2mK9pNvR4", // URL or bare token
  "status": "all",             // optional — "open" | "resolved" | "all"
  "since": "2026-07-01T00:00Z",// optional ISO 8601 for delta pulls
  "format": "prompt",          // optional — "prompt" (Markdown) | "json"
  "locale": "ja"               // optional — "ja" | "en"
}

デフォルトで Markdown を返します。エージェントがそのままコンテキストに貼り付けられる形式です。

list_deployments

{
  "limit": 20,     // optional — 1-100, default 20
  "archived": false
}

/api/v1/rooms の JSON をそのまま返します。

デバッグ

ログ行は標準エラー出力のみに書き込まれます。標準出力は JSON-RPC 用に予約されています。サーバーの動作を確認するには：

BRIEFROOM_TOKEN=$YOUR_PAT npx @modelcontextprotocol/inspector \
  npx -y @briefroom/mcp

ローカルの開発サーバーに接続して開発する場合は、インスペクターの接続先バックエンドに BRIEFROOM_API_URL=http://localhost:3000 を設定してください。

ロードマップ

• resolve_comment — コメント PATCH エンドポイントでのバックエンド PAT サポート待ちです。
• ホスト型の利用向け Streamable HTTP トランスポート。

コントリビューション

github.com/briefroom/mcp で、イシューやプルリクエストを歓迎しています。公開リポジトリは、briefroom モノレポにある内部の信頼できるソースを反映しています。変更はまず上流に反映され、その後ここにエクスポートされます。

このリポジトリ内でのローカル開発：

npm install
npm run build
npm test

ライセンス

MIT © Talent Cloud, Inc.