pipefy-toolkit-setup

Original🇺🇸 English
Translated

Guide a first-time user through Pipefy AI toolkit setup (hosted MCP, local install.sh, or Claude Code plugin). Use when the user asks to install Pipefy MCP, connect Claude/Cursor to Pipefy, run /pipefy:install, or set up mcp.pipefy.com. Do not use for day-to-day Pipefy workflows after MCP is already working.

9installs
Added on

NPX Install

npx skill4agent add pipefy/ai-toolkit pipefy-toolkit-setup

Tags

Translated version includes tags in frontmatter

Pipefy toolkit setup (first-time onboarding)

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
.

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, …).

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

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

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)

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.

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

See also

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