Pipefy Reports logo

Pipefy Reports

Organization
pipefy
pipefy-reports

Use this skill when the user wants to create, read, update, delete, or export pipe reports or organization reports. Covers the async export workflow (trigger, poll, download).

Overview

Publisherpipefy
Repositoryai-toolkit
Skill namepipefy-reports
Stars
52
Forks
24
Bundled files
2
LicenseApache-2.0
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • 2 bundled files

    Scripts, templates, and references the model can read while it works. Files are read-only and never executed.

  • Open source

    Published by pipefy on GitHub. Read the source before you install it.

Installation

Install the Pipefy Reports AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
    https://github.com/pipefy/ai-toolkit/tree/main/plugins/pipefy/skills/pipefy-reports
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/pipefy/ai-toolkit.git /tmp/ai-toolkit
mkdir -p .claude/skills
cp -r /tmp/ai-toolkit/plugins/pipefy/skills/pipefy-reports .claude/skills/pipefy-reports
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Pipefy Reports in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Pipefy Reports on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Pipefy Reports is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Reports

Read the MCP reference or CLI reference for the surface you are using. Load only the relevant reference.

Pipe reports and organization reports: discovery, CRUD, and async exports.


Cross-cutting patterns

  • Build ReportCardsFilter using get_pipe_report_columns and get_pipe_report_filterable_fields; use introspect_type for uncommon inputs.
  • get_pipe_reports omits cardCount in the query (Pipefy can error when resolving it).

Pipe report tools

OperationRead-onlyPurpose
get_pipe_reportsYesList all reports for a pipe.
get_pipe_reportsYesLoad one report by report_id when needed.
get_pipe_report_columnsYesDiscover available columns for a report filter.
get_pipe_report_filterable_fieldsYesDiscover filterable fields for a report.
create_pipe_reportNoCreate a new pipe report.
update_pipe_reportNoUpdate report name or filters.
delete_pipe_reportNoDestructive; review and approve first. Use the selected surface's confirmation flow if one exists.
export_pipe_reportNoTrigger async export.

Organization report tools

OperationRead-onlyPurpose
get_organization_reportsYesList all org-level reports.
get_organization_reportYesSingle org report data.
create_organization_reportNoCreate an org-wide report.
update_organization_reportNoUpdate report config.
delete_organization_reportNoDestructive; review and approve first. Use the selected surface's confirmation flow if one exists.
export_organization_reportNoTrigger async export.

Export status & download

OperationPurpose
get_pipe_report_exportPoll pipe report export status (after export_pipe_report).
get_organization_report_exportPoll org report export status (after export_organization_report).
export_pipe_audit_logsExport pipe audit logs (separate from card report exports).

Steps — export a pipe report

  1. List available reports:

    Operation: get_pipe_reports pipe_uuid=<PIPE_UUID> (get_pipe supplies the UUID).

  2. Trigger the export:

    Operation: export_pipe_report pipe_id=67890 pipe_report_id=123

  3. Poll until done:

    Operation: get_pipe_report_export export_id=<EXPORT_ID>

    Repeat every 5–10 seconds until state is done (or failed).

  4. Download: use the signed fileURL from the done export response over HTTPS.

    The link expires 1 hour after the read that returned it, and anyone holding it can download the file until then. When you hand it to the user, say that it expires in 1 hour; for a fresh link, read the export again.


Steps — create a filtered pipe report

  1. Discover filterable fields:

    Operation: get_pipe_report_filterable_fields pipe_uuid=<PIPE_UUID> (get_pipe supplies the UUID).

  2. Create the report with a ReportCardsFilter shape (not a top-level current_phase array):

    Arguments:

    create_pipe_report pipe_id=67890 name="Phase subset" filter='{"operator":"and","queries":[{"field":"current_phase","operator":"eq","type":"select","value":"<phase_id>"}]}'

    Use the exact field string from step 1. Invalid shapes are rejected before GraphQL with a message pointing at get_pipe_report_filterable_fields.


Success criteria

  • get_pipe_report_export (or get_organization_report_export) reaches a terminal done or failed state.
  • Downloaded export contains the expected card/report data.

Failure modes

  • Export stuck in processing: large pipes with many cards can take minutes. If the export is still processing after a minute of polling every 5 to 10 seconds, poll once every 60 seconds instead. Retry the export trigger if still processing after several minutes.
  • get_pipe_reports returns null for cardCount: known Pipefy API behavior; the tool omits that field automatically.
  • Filter rejected before GraphQL: do not pass {"current_phase":["id"]}; use operator + queries (see step 2 above).
  • Filter not working after create: use get_pipe_report_filterable_fields to confirm the exact field string and value format.

See also

  • pipefy-observability — export automation job history (different from pipe reports).
  • pipefy-introspection — discover ReportCardsFilter input shape for complex filters.

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the Pipefy Reports AI skill do?

Use this skill when the user wants to create, read, update, delete, or export pipe reports or organization reports. Covers the async export workflow (trigger, poll, download).

Why use Pipefy Reports on TypingMind?

Because you install it once and use it with any model. Pipefy Reports is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Pipefy Reports in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/pipefy/ai-toolkit/tree/main/plugins/pipefy/skills/pipefy-reports. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Pipefy Reports?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Pipefy Reports?

As many as you like. As long as a model supports skills, you can use Pipefy Reports with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Pipefy Reports AI skill free?

Yes. It is published on GitHub by pipefy under the Apache-2.0 license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇