Back to Details

pipefy-toolkit-setup

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Pipefy toolkit setup (first-time onboarding)

Pipefy工具包设置（首次入门）

Canonical install snippets live only in the root 
README.md#installation
 (#246: no second god-doc of commands). This skill is the agent checklist — print or run the README blocks verbatim; do not invent alternate commands.
Edge cases: 
packages/mcp/README.md
. Auth: 
docs/cli/auth.md
. Env: 
docs/config.md
.
标准安装代码片段仅存在于根目录的
README.md#installation
中（#246：请勿重复编写命令文档）。本技能是Agent的检查清单——请一字不差地打印或运行README中的代码块；请勿自行编写替代命令。
边缘情况参考：
packages/mcp/README.md
。认证相关：
docs/cli/auth.md
。环境配置：
docs/config.md
。

When to use

使用场景

  • "Set up Pipefy", "install the MCP", "connect Claude/Cursor to Pipefy"
  • User mentions 
    /plugin marketplace add
    , 
    /pipefy:install
    , or 
    mcp.pipefy.com
  • Fresh machine with no 
    pipefy
    on PATH and no Pipefy MCP server
Do not use once tools already work — switch to a domain skill (pipes, tables, …).
  • 用户提出“设置Pipefy”、“安装MCP”、“将Claude/Cursor连接到Pipefy”等需求
  • 用户提及
    /plugin marketplace add
    、
    /pipefy:install
    或
    mcp.pipefy.com
  • 新机器上未配置
    pipefy
    环境变量，且未部署Pipefy MCP服务器
请勿在工具已正常工作后使用——此时应切换到领域技能（如管道、表格等）。

Prerequisites

前置条件

  • User has a Pipefy account (Admin access if they need a service account).
  • Hosted MCP: Claude Code CLI (
    claude
    ).
  • Local toolkit: a shell that can run 
    curl
    (
    install.sh
    can install 
    uv
    ).
Who does what
ActorDoes
AgentAsks path; prints README commands verbatim; runs shell 
claude mcp add
/ 
install.sh
when the user agrees; checks 
claude mcp get
/ list
User typesClaude slash commands (
/plugin …
, 
/pipefy:…
) — the model cannot invoke them
User in browserOAuth for hosted (
claude mcp login …
) or 
/pipefy:pipefy-login
/ 
pipefy auth login
  • 用户拥有Pipefy账户（如需服务账户则需管理员权限）。
  • 托管MCP：需安装Claude Code CLI（
    claude
    ）。
  • 本地工具包：需支持
    curl
    的Shell环境（
    install.sh
    可安装
    uv
    ）。
角色职责划分
角色职责
Agent询问用户选择的路径；一字不差地打印README中的命令；在用户同意时运行Shell命令
claude mcp add
/ 
install.sh
；检查
claude mcp get
命令输出或列表
用户输入输入Claude斜杠命令（
/plugin …
、
/pipefy:…
）——模型无法自行调用这些命令
浏览器端用户完成托管模式的OAuth认证（
claude mcp login …
）或执行
/pipefy:pipefy-login
/ 
pipefy auth login
命令

Tools needed

所需工具

Setup is outside the Pipefy MCP tool surface. After auth succeeds, verify with:
Tool (MCP)CLI equivalentRead-only
list_organizations
pipefy org list
Yes
get_organization
pipefy org get
Yes
设置过程在Pipefy MCP工具范围之外。认证成功后，可通过以下方式验证：
工具（MCP）CLI等效命令是否只读
list_organizations
pipefy org list
是
get_organization
pipefy org get
是

Steps

步骤

  1. Choose one path — ask the user; do not pick silently.
    If they only say “Claude Code” (no path), ask a closed question:
    Hosted MCP (zero local Python, 
    mcp.pipefy.com
    ) or the Claude Code plugin (slash commands + local CLI)? If you’re unsure, Hosted is the usual first try.
    PathREADME sectionOutcome
    Hosted MCPHosted MCPHTTPS 
    mcp.pipefy.com
    (remote-safe tools)
    Local toolkitQuick install
    install.sh
    → local server + CLI
    Claude Code pluginClaude Code pluginMarketplace + slash install/login
    CLI onlyCLI
    pipefy
    on PATH; no MCP
    Never register both hosted HTTP and local stdio/plugin under the MCP server name 
    pipefy
    .
  2. Execute the chosen README block — run it in the shell, or print it for the user to paste (required for Claude slash commands). Do not reorder the plugin sequence: marketplace → 
    /plugin install pipefy
    → 
    /pipefy:install
    → 
    /pipefy:pipefy-login
    .
  3. Auth — hosted: finish the client browser OAuth prompt (
    claude mcp login <name>
    if status is Needs authentication). Local/plugin/CLI: 
    pipefy auth login
    or 
    /pipefy:pipefy-login
    (see README). Service accounts: 
    docs/config.md
    .
  4. Verify
    • Shell (local / plugin / CLI): 
      pipefy --version
    • MCP: call 
      list_organizations
      (needs no id — the natural first read; confirms the credential works and surfaces the org ids other tools need) or another read-only tool the user allows
    • Confirm exactly one 
      pipefy
      MCP registration for the path you chose (hosted vs plugin)
  1. 选择一种路径——询问用户，请勿自行决定。
    如果用户仅提及“Claude Code”未指定路径，请提出封闭式问题：
    选择托管MCP（无需本地Python环境，使用
    mcp.pipefy.com
    ）还是Claude Code插件（斜杠命令+本地CLI）？若不确定，托管模式通常是首次尝试的首选。
    路径README对应章节结果
    托管MCPHosted MCP使用HTTPS协议的
    mcp.pipefy.com
    （远程安全工具）
    本地工具包快速安装脚本通过
    install.sh
    搭建本地服务器+CLI
    Claude Code插件Claude Code插件插件市场+斜杠命令安装/登录
    仅CLICLI
    pipefy
    加入环境变量；无MCP
    请勿同时注册托管HTTP和本地标准输入输出/插件两种模式的MCP服务器，并命名为
    pipefy
    。
  2. 执行所选README中的代码块——在Shell中运行，或打印给用户粘贴（Claude斜杠命令必须如此操作）。请勿调整插件安装顺序：插件市场 → 
    /plugin install pipefy
    → 
    /pipefy:install
    → 
    /pipefy:pipefy-login
    。
  3. 认证——托管模式：完成客户端浏览器的OAuth提示（若状态为“需要认证”则执行
    claude mcp login <name>
    ）。本地/插件/CLI模式：执行
    pipefy auth login
    或
    /pipefy:pipefy-login
    （详见README）。服务账户配置参考：
    docs/config.md
    。
  4. 验证
    • Shell环境（本地/插件/CLI）：执行
      pipefy --version
    • MCP：调用
      list_organizations
      （无需ID——这是最自然的首次只读操作，可确认凭证有效并显示其他工具所需的组织ID）或用户允许的其他只读工具
    • 确认仅注册了所选路径对应的一个
      pipefy
      MCP（托管或插件模式）

Success criteria

成功标准

  • One active Pipefy MCP registration for the chosen path (or CLI-only with no MCP).
  • Auth completed.
  • Read-only MCP call or 
    pipefy --version
    succeeds.
  • 所选路径对应一个活跃的Pipefy MCP注册（或仅CLI模式无MCP）。
  • 认证完成。
  • 只读MCP调用或
    pipefy --version
    执行成功。

Failure modes

故障排查

SymptomLikely causeRecovery
Slash commands missingPlugin not installedREADME Claude Code plugin — marketplace + install first
Two 
pipefy
MCP entries		Hosted + plugin both registered
claude mcp remove <name> -s user
(or client settings)
Needs authentication
after hosted add		OAuth not finished
claude mcp login <name>
+ browser
pipefy: command not found
CLI not on PATH
/pipefy:install
or README CLI; check 
$HOME/.local/bin
MCP tools empty / auth errorsLogin not doneRe-run login; service accounts → 
docs/config.md
macOS 
errSecInvalidOwnerEdit
Keychain write
packages/mcp/README.md
症状可能原因解决方法
斜杠命令缺失未安装插件参考README中的Claude Code插件章节——先进入插件市场安装
存在两个
pipefy
MCP条目		同时注册了托管和插件模式执行
claude mcp remove <name> -s user
（或在客户端设置中删除）
添加托管MCP后显示“需要认证”未完成OAuth执行
claude mcp login <name>
并完成浏览器认证
提示
pipefy: command not found
CLI未加入环境变量执行
/pipefy:install
或参考README中的CLI章节；检查
$HOME/.local/bin
路径
MCP工具为空/认证错误未完成登录重新执行登录；服务账户配置参考
docs/config.md
macOS系统提示
errSecInvalidOwnerEdit
钥匙串写入问题参考
packages/mcp/README.md

See also

相关链接

  • README.md#installation
  • skills/README.md
  • README.md#installation
  • skills/README.md