Skip to main content

How to set up the Pipefy AI Toolkit in your AI Assistant

  • June 8, 2026
  • 0 replies
  • 765 views
vinicius.pereira
Community Manager

👤  For pipe admins and operations teams
🔐  Available on all plans
🎯  For anyone who wants to operate Pipefy in natural language from the AI assistant they already use

 

Your Pipefy processes can now be triggered directly from the AI assistant you already use every day. Instead of opening the app to create a card, move a stage, or pull a report, you type what you need and the assistant takes care of it.

By the end of this article, you'll know how to install and configure the Pipefy AI Toolkit on your computer and connect it to your preferred AI assistant, ready to operate Pipefy in natural language.

 

📖  What you'll learn here:

 

What is the Pipefy AI Toolkit

The Pipefy AI Toolkit is an open source package that connects Pipefy to AI assistants compatible with the MCP (Model Context Protocol). It has three components:

 

Component

What it does

pipefy-mcp-server

Exposes Pipefy tools for the AI assistant to call (pipes, cards, automations, AI Agents, reports, and more)

Pipefy CLI

Lets you operate Pipefy from the terminal with direct commands

Skills

Ready-made playbooks that teach the assistant to follow best practices for each use case

 

The toolkit works with Cursor, Claude Desktop, Claude Code, Codex, and any other MCP-compatible client.

 

The toolkit does not replace the Pipefy web interface. It automates what you would already do in the UI, with confirmation required before any destructive action.

 

What you need before you start

Pipefy account and permissions

You need admin access on the pipes where the assistant will operate. If you plan to use a service account (recommended for keeping the MCP always connected without relying on a browser session), create the account under Admin > Service Accounts in Pipefy and add it as a member of the relevant pipes.

 

Software on your computer

Requirement

Detail

Operating system

macOS, Linux, or Windows

Python 3.11 or higher

The installer handles this automatically in most cases

AI client

Cursor, Claude Desktop, Claude Code, Codex, or another MCP-compatible client

 

Installation

The installer sets up the CLI and MCP server in a single command. Replace cursor with your client name:

 

curl -fsSL https://raw.githubusercontent.com/pipefy/ai-toolkit/main/install.sh \
| sh -s -- --client cursor

 

Available clients: cursor, claude-code, claude-desktop, codex. Use none if you want to install without registering automatically in the client and paste the config yourself.

 

Useful flags

Flag

Effect

--yes

Installs without confirmation prompts

--no-skills

Skips playbook installation

--dry-run

Shows what the command would do without executing anything

--client none

Installs only; you paste the config into the client manually

 

After installation, confirm the commands are available:

 

pipefy --help
pipefy-mcp-server --help

 

If you see command not found, add ~/.local/bin to your terminal PATH (the installer warns you when this is needed).

 

Authentication

Choose one of three options based on your situation:

 

Option A: Browser login (recommended for personal use and CLI)

 

pipefy auth login

 

Opens your browser, completes OAuth, and stores the session in your system keychain. The simplest option for personal use on your own computer.

 

On headless environments (remote servers), use:

 

pipefy auth login --device

 

Option B: Service account (recommended for always-on MCP)

Best when you want the AI assistant to work without depending on an open browser session. Configure credentials in ~/.config/pipefy/config.toml:

 

service_account_client_id = "YOUR_CLIENT_ID"
service_account_client_secret = "YOUR_CLIENT_SECRET"

 

Or as environment variables:

 

PIPEFY_SERVICE_ACCOUNT_CLIENT_ID=...
PIPEFY_SERVICE_ACCOUNT_CLIENT_SECRET=...

 

Option C: Bearer token (for quick one-off tests)

 

pipefy --token "YOUR_BEARER" pipe list

 

Never put your client secret or token in Git repositories, screenshots, or shared documents.

 

Precedence: --token > PIPEFY_TOKEN > service account > auth login session. If the CLI is using the wrong credentials, check for environment variables overriding your stored session.

 

Activating the MCP in your AI assistant

After installing with --client <name>, the server is already registered. If you chose --client none, paste the JSON below into your client's config file:

 

{
"mcpServers": {
"pipefy": {
"command": "pipefy-mcp-server"
}
}
}

 

If you're using a service account, add the environment variables inside the block:

 

{
"mcpServers": {
"pipefy": {
"command": "pipefy-mcp-server",
"env": {
"PIPEFY_SERVICE_ACCOUNT_CLIENT_ID": "YOUR_CLIENT_ID",
"PIPEFY_SERVICE_ACCOUNT_CLIENT_SECRET": "YOUR_CLIENT_SECRET"
}
}
}
}

 

Cursor

Config file: ~/.cursor/mcp.json (macOS/Linux) or %USERPROFILE%\.cursor\mcp.json on Windows.

 

After saving, restart Cursor and confirm under Settings > MCP that the pipefy server shows as Enabled.

 

Claude Desktop

Config file: ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows).

 

After saving, restart Claude Desktop.

 

Claude Code

In the terminal, for your project or globally:

 

/plugin marketplace add pipefy/ai-toolkit
/plugin install pipefy
/pipefy:install
/pipefy:login

 

To use a service account with Claude Code, edit ~/.claude.json and add the env block to the pipefy server.

 

Terminal alternative:

 

claude mcp add --scope project pipefy -- pipefy-mcp-server
claude mcp add-env pipefy PIPEFY_SERVICE_ACCOUNT_CLIENT_ID <ID>
claude mcp add-env pipefy PIPEFY_SERVICE_ACCOUNT_CLIENT_SECRET <SECRET>

 

Codex

Add to ~/.codex/config.toml:

 

[mcp_servers.pipefy]
command = "pipefy-mcp-server"

 

Restart Codex after saving.

 

Other MCP clients

Use the same pattern: command pipefy-mcp-server, stdio transport, environment variables for credentials. Check your client's documentation for the exact config file path.

 

Confirming everything works

After restarting your client, ask the assistant:

 

"Use the search_pipes tool to list pipes with names containing 'HR'." If the assistant returns a list of pipes, the MCP is connected and authenticated.

 

If you see an authentication error, configure the service account or run pipefy auth login again. If you see PERMISSION_DENIED, add the service account (or your user) as a member of the target pipe.

 

Common setup issues

Symptom

What to do

Assistant says it has no Pipefy tools

Enable the pipefy server in MCP settings and restart the app

command not found after installation

Add ~/.local/bin to your PATH and open a new terminal

Invalid JSON config

Check for missing commas or brackets in mcp.json or claude_desktop_config.json

401 error or auth failure

Check the ID/secret and confirm the service account is a member of the pipe

MCP works in Cursor but not in Claude Desktop

Each app has a separate config file; run the activation again with --client claude-desktop

pipefy auth login fails on macOS

Run it once from Terminal.app and approve the keychain dialog

 

Before you move on, confirm that you:

  • Understand that the Pipefy AI Toolkit connects your AI assistant to Pipefy via the MCP protocol
  • Chose and configured one of the three authentication options
  • See the pipefy server as connected in your AI client
  • Tested with a simple prompt and got real Pipefy data back

 

Need help or want to join the group of early customers testing the Pipefy AI Toolkit?