Pane

Name: Pane
Author: aerolalit

本地服务

github.com/aerolalit开发工具

代码仓库

关于 Pane

通过 URL 将丰富的交互式 UI 交给真人使用，并从任意 MCP 客户端获取结构化数据。

配置

本地服务的配置在各客户端中通用，复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置

{
  "mcpServers": {
    "aerolalit-pane": {
      "command": "npx",
      "args": [
        "-y",
        "@paneui/mcp"
      ],
      "env": {
        "PANE_API_KEY": "<PANE_API_KEY>",
        "PANE_URL": "<PANE_URL>",
        "PANE_AGENT_NAME": "<PANE_AGENT_NAME>",
        "PANE_REGISTER_SECRET": "<PANE_REGISTER_SECRET>"
      }
    }
  }
}

启动命令npx -y @paneui/mcp

需要配置的环境变量

PANE_API_KEY密钥Pane agent API key. If unset, the server auto-registers a fresh agent against the relay on first use and saves the key to the shared CLI store (~/.config/pane/config.json).

PANE_URLPane relay base URL. Defaults to the hosted relay https://relay.paneui.com; set this to point at a self-hosted relay.

PANE_AGENT_NAMEDisplay name for the auto-registered agent on the relay.

PANE_REGISTER_SECRET密钥Registration secret, required only for relays running REGISTRATION_MODE=secret.

本地服务需要在你的电脑上安装运行环境（如 Node.js 18+）。各客户端的配置文件位置不同，请参考客户端文档。

安装包

npm@paneui/mcp0.0.26stdio

工具

收录的工具列表 · 更新于 2 周前

参数	类型	必填	说明
html	string	否	窗格的 UI，采用完整的内联 HTML 文档。若要向你发送数据，页面会调用 window.pane.emit(eventType, payload)——每个发出的 eventType 都必须在 event_schema 中声明，且 emittedBy 包含 'page'。读取 window.pane.inputData 获取种子数据。传入 `html`（+`name`）创建一次性页面，或传入 `template_id` 复用已保存的模板，二者不可同时传入。
name	string	否	自动创建的模板的人类可读简短标签（例如 'Deploy approval'）。传入 `html`（内联表单）时为必填；通过 `template_id` 复用现有模板时省略（将继承模板名称）。
tags	array	否	可选的窗格级筛选标签（与模板标签合并）。最多 20 个标签，每个最多 50 个字符；'favorite'／'favorites' 为保留值。
title	string	否	供用户使用的可选浏览器标签页标题（≤80 个字符）。默认使用 `name`。
callback	object	否	可选的 webhook 回调配置，使中继服务将新事件 POST 到你的端点。格式遵循中继服务的回调架构（例如 { url, secret? }）。大多数 MCP Agent 会改用 get_events 轮询。
metadata	object	否	可选的不透明 JSON，可附加到窗格以供内部记录（不会显示给用户，可通过 run_query 查询）。
preamble	string	否	可选的一至两行上下文，显示在 UI 上方——“谁在请求，以及原因”。
icon_emoji	string	否	可选的单个 Emoji 图标，用于覆盖此窗格的图标。
input_data	object	否	此窗格实例的可选初始数据，可在页面中通过 window.pane.inputData 读取（例如要审查的差异、要选择的选项）。
context_key	string	否	可选的自然键（例如 'pr-42'）。使用相同 (template, key) 重复调用 create_pane 会返回同一个窗格，使重试具有幂等性。
template_id	string	否	复用现有的命名模板（id 或 slug），而非内联 HTML。模板固定的版本会提供 HTML + event/input/record schemas。不可与 `html`/`name`/`event_schema`/`input_schema` 同时使用。使用 `template` 工具创建模板。
ttl_seconds	integer	否	可选的窗格存续时间（秒）。中继会将其限制在最大值以内；返回的 expires_at 是权威值。
event_schema	object	否	仅适用于内联表单。声明页面（以及你）可以发出的事件，并验证每个负载。结构：{ events: { '<type>': { emittedBy: ['page'\|'agent'...], payload: <JSON Schema> } } }。只读窗格请省略。
input_schema	object	否	仅适用于内联表单。用于验证 input_data 的可选 JSON Schema。如果 input_data 引用了页面必须下载的已上传附件 ID，则为必填。
participants	integer	否	要生成的不同人类参与者 URL 数量（可选，默认值为 1）。每位参与者都会在返回的 `urls` 数组中获得自己的 URL。
record_schema	object	否	仅适用于内联表单。JSON Schema 2020-12 文档，带有 `x-pane-collections` 扩展，用于声明此窗格的可变记录集合（待办事项、评论等）。仅事件窗格请省略。
template_version	integer	否	与 `template_id` 一起使用：将此窗格固定到特定的模板版本。默认使用模板 head 的最新版本。
icon_attachment_id	string	否	可选的单窗格图标，使用现成的栅格图像附件 ID（png/jpeg/webp/gif）。请先通过 `attachments` 工具上传（作用域：pane 或 agent）。