Skip to content

Commit b47c1c2

Browse files
committed
fix: review feedback for Pipefy adapter (format, live spec)
Address changes-requested review on #1373: - pretty-print pipefy.json (2-space indent + trailing newline), matching the format of all other adapters for readable future diffs - pipefy.live.spec.ts: the live block now performs a real GraphQL call (organizations query with PIPEFY_API_TOKEN) when RUN_PIPEFY_LIVE=1 and asserts data.organizations is an array; still skipped in CI without a token - PR title/body changed from 'fixes #982' to 'Part of #982' so the claim-pool issue is not auto-closed on merge (done via API) - logo: no official Pipefy SVG press kit found; keeping the current mark
1 parent db29e03 commit b47c1c2

2 files changed

Lines changed: 190 additions & 11 deletions

File tree

Lines changed: 170 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,170 @@
1-
{"category":"project-management","connector":{"authConfig":{"token":"{{PIPEFY_API_TOKEN}}"},"authType":"BEARER_TOKEN","baseUrl":"https://api.pipefy.com/graphql","headers":{"Content-Type":"application/json","User-Agent":"AnythingMCP"},"name":"Pipefy GraphQL API","type":"GRAPHQL"},"description":"Pipefy work management platform: organizations, pipes (workflows), cards and phases through the GraphQL API. List the pipes an AI assistant can see, track cards as they move through phases, and read card field values.","docsUrl":"https://developers.pipefy.com/","icon":"pipefy","instructions":"**Getting credentials**\n1. Pipefy authenticates API calls with a bearer token. You can use a **Personal Access Token** (go to https://app.pipefy.com/tokens, \"Generate new token\", give it a description and save — use the longer token shown there) or a **Service Account** token (recommended for production, see the Authentication page in the Pipefy developer docs). Either way, set `PIPEFY_API_TOKEN`.\n2. The adapter sends it as `Authorization: Bearer <token>` on every call.\n\n**Identifiers**\nAll Pipefy ids are numeric: a pipe id is the number in the pipe URL (e.g. `301234567` in `https://app.pipefy.com/pipes/301234567`), likewise card, phase and organization ids. Pass them as strings, e.g. `\"301234567\"`.\n\n**Pagination and limits**\n`pipefy_list_cards` pages with `first`/`after`: `first` caps the page (default 25, max 50 — the most Pipefy returns per request), and when `pageInfo.hasNextPage` is true, pass `pageInfo.endCursor` as `after` for the next page. Pipefy also enforces a monthly API-call quota that depends on the plan; one tool call is one API call.\n\n**Common workflows**\n- Explore: `pipefy_list_organizations` → `pipefy_list_pipes` (with an organization id) → `pipefy_get_pipe` (phases of one pipe).\n- Track work: `pipefy_list_cards` (cards in a pipe, optionally paged) → `pipefy_get_card` (full field values of one card).\n- Phase detail: `pipefy_get_phase` for a phase's card count and its fields.\n\n**Limitations**\nThis adapter is read-only: it lists and inspects pipes, cards, phases and organizations. It does not create, move or update cards — Pipefy mutations are out of scope for this version. The `search` argument of the cards query is not exposed; page through `pipefy_list_cards` instead.","name":"Pipefy","probe":{"tool":"pipefy_list_organizations"},"region":"intl","requiredEnvVars":["PIPEFY_API_TOKEN"],"slug":"pipefy","tools":[{"description":"List the organizations the token can see, with their id and name. The lightest call — it doubles as the auth check. Organization ids narrow pipefy_list_pipes.","endpointMapping":{"method":"query","path":"query Organizations { organizations { id name } }"},"name":"pipefy_list_organizations","parameters":{"properties":{},"type":"object"}},{"description":"List the pipes (workflows) of one organization, with their id and name. Pipe ids narrow pipefy_get_pipe and pipefy_list_cards.","endpointMapping":{"method":"query","path":"query Pipes($orgId: ID!) { organization(id: $orgId) { id name pipes { id name } } }","queryParams":{"orgId":"$org_id"}},"name":"pipefy_list_pipes","parameters":{"properties":{"org_id":{"description":"Organization id, e.g. \"123456\" (the number in the organization URL). pipefy_list_organizations lists them.","type":"string"}},"required":["org_id"],"type":"object"}},{"description":"Show one pipe in full: id, name, card counts, its phases (id and name), the start-form fields and the labels. Use it to learn the phase ids before listing cards.","endpointMapping":{"method":"query","path":"query Pipe($pipeId: ID!) { pipe(id: $pipeId) { id name cards_count opened_cards_count phases { id name } start_form_fields { id label } labels { id name color } } }","queryParams":{"pipeId":"$pipe_id"}},"name":"pipefy_get_pipe","parameters":{"properties":{"pipe_id":{"description":"Pipe id, e.g. \"301234567\" (the number in the pipe URL).","type":"string"}},"required":["pipe_id"],"type":"object"}},{"description":"List cards of one pipe, a page at a time: id, title, done flag, update time, current phase and assignees. Page with first/after — when pageInfo.hasNextPage is true, pass pageInfo.endCursor as after.","endpointMapping":{"method":"query","path":"query Cards($pipeId: ID!, $first: Int = 25, $after: String) { allCards(pipeId: $pipeId, first: $first, after: $after) { pageInfo { hasNextPage endCursor } edges { node { id title done updated_at current_phase { id name } assignees { name email } } } } }","queryParams":{"after":"$after","first":"$first","pipeId":"$pipe_id"}},"name":"pipefy_list_cards","parameters":{"properties":{"after":{"description":"Cursor for the next page: the pageInfo.endCursor of the previous call. Omit for the first page.","type":"string"},"first":{"description":"Cards per page (default 25, max 50 — the most Pipefy returns per request).","maximum":50,"minimum":1,"type":"integer"},"pipe_id":{"description":"Pipe id, e.g. \"301234567\". pipefy_list_pipes lists them.","type":"string"}},"required":["pipe_id"],"type":"object"}},{"description":"Show one card in full: id, title, done flag, its pipe and current phase, every field with its name and value, and the assignees.","endpointMapping":{"method":"query","path":"query Card($cardId: ID!) { card(id: $cardId) { id title done updated_at pipe { id name } current_phase { id name } fields { name value filled_at } assignees { name email } } }","queryParams":{"cardId":"$card_id"}},"name":"pipefy_get_card","parameters":{"properties":{"card_id":{"description":"Card id, e.g. \"123456789\" (the number in the card URL).","type":"string"}},"required":["card_id"],"type":"object"}},{"description":"Show one phase: id, name, how many cards it holds, and the fields defined on it.","endpointMapping":{"method":"query","path":"query Phase($phaseId: ID!) { phase(id: $phaseId) { id name cards_count fields { id label } } }","queryParams":{"phaseId":"$phase_id"}},"name":"pipefy_get_phase","parameters":{"properties":{"phase_id":{"description":"Phase id, e.g. \"12345678\". pipefy_get_pipe lists a pipe's phases.","type":"string"}},"required":["phase_id"],"type":"object"}}]}
1+
{
2+
"category": "project-management",
3+
"connector": {
4+
"authConfig": {
5+
"token": "{{PIPEFY_API_TOKEN}}"
6+
},
7+
"authType": "BEARER_TOKEN",
8+
"baseUrl": "https://api.pipefy.com/graphql",
9+
"headers": {
10+
"Content-Type": "application/json",
11+
"User-Agent": "AnythingMCP"
12+
},
13+
"name": "Pipefy GraphQL API",
14+
"type": "GRAPHQL"
15+
},
16+
"description": "Pipefy work management platform: organizations, pipes (workflows), cards and phases through the GraphQL API. List the pipes an AI assistant can see, track cards as they move through phases, and read card field values.",
17+
"docsUrl": "https://developers.pipefy.com/",
18+
"icon": "pipefy",
19+
"instructions": "**Getting credentials**\n1. Pipefy authenticates API calls with a bearer token. You can use a **Personal Access Token** (go to https://app.pipefy.com/tokens, \"Generate new token\", give it a description and save — use the longer token shown there) or a **Service Account** token (recommended for production, see the Authentication page in the Pipefy developer docs). Either way, set `PIPEFY_API_TOKEN`.\n2. The adapter sends it as `Authorization: Bearer <token>` on every call.\n\n**Identifiers**\nAll Pipefy ids are numeric: a pipe id is the number in the pipe URL (e.g. `301234567` in `https://app.pipefy.com/pipes/301234567`), likewise card, phase and organization ids. Pass them as strings, e.g. `\"301234567\"`.\n\n**Pagination and limits**\n`pipefy_list_cards` pages with `first`/`after`: `first` caps the page (default 25, max 50 — the most Pipefy returns per request), and when `pageInfo.hasNextPage` is true, pass `pageInfo.endCursor` as `after` for the next page. Pipefy also enforces a monthly API-call quota that depends on the plan; one tool call is one API call.\n\n**Common workflows**\n- Explore: `pipefy_list_organizations` → `pipefy_list_pipes` (with an organization id) → `pipefy_get_pipe` (phases of one pipe).\n- Track work: `pipefy_list_cards` (cards in a pipe, optionally paged) → `pipefy_get_card` (full field values of one card).\n- Phase detail: `pipefy_get_phase` for a phase's card count and its fields.\n\n**Limitations**\nThis adapter is read-only: it lists and inspects pipes, cards, phases and organizations. It does not create, move or update cards — Pipefy mutations are out of scope for this version. The `search` argument of the cards query is not exposed; page through `pipefy_list_cards` instead.",
20+
"name": "Pipefy",
21+
"probe": {
22+
"tool": "pipefy_list_organizations"
23+
},
24+
"region": "intl",
25+
"requiredEnvVars": [
26+
"PIPEFY_API_TOKEN"
27+
],
28+
"slug": "pipefy",
29+
"tools": [
30+
{
31+
"description": "List the organizations the token can see, with their id and name. The lightest call — it doubles as the auth check. Organization ids narrow pipefy_list_pipes.",
32+
"endpointMapping": {
33+
"method": "query",
34+
"path": "query Organizations { organizations { id name } }"
35+
},
36+
"name": "pipefy_list_organizations",
37+
"parameters": {
38+
"properties": {},
39+
"type": "object"
40+
}
41+
},
42+
{
43+
"description": "List the pipes (workflows) of one organization, with their id and name. Pipe ids narrow pipefy_get_pipe and pipefy_list_cards.",
44+
"endpointMapping": {
45+
"method": "query",
46+
"path": "query Pipes($orgId: ID!) { organization(id: $orgId) { id name pipes { id name } } }",
47+
"queryParams": {
48+
"orgId": "$org_id"
49+
}
50+
},
51+
"name": "pipefy_list_pipes",
52+
"parameters": {
53+
"properties": {
54+
"org_id": {
55+
"description": "Organization id, e.g. \"123456\" (the number in the organization URL). pipefy_list_organizations lists them.",
56+
"type": "string"
57+
}
58+
},
59+
"required": [
60+
"org_id"
61+
],
62+
"type": "object"
63+
}
64+
},
65+
{
66+
"description": "Show one pipe in full: id, name, card counts, its phases (id and name), the start-form fields and the labels. Use it to learn the phase ids before listing cards.",
67+
"endpointMapping": {
68+
"method": "query",
69+
"path": "query Pipe($pipeId: ID!) { pipe(id: $pipeId) { id name cards_count opened_cards_count phases { id name } start_form_fields { id label } labels { id name color } } }",
70+
"queryParams": {
71+
"pipeId": "$pipe_id"
72+
}
73+
},
74+
"name": "pipefy_get_pipe",
75+
"parameters": {
76+
"properties": {
77+
"pipe_id": {
78+
"description": "Pipe id, e.g. \"301234567\" (the number in the pipe URL).",
79+
"type": "string"
80+
}
81+
},
82+
"required": [
83+
"pipe_id"
84+
],
85+
"type": "object"
86+
}
87+
},
88+
{
89+
"description": "List cards of one pipe, a page at a time: id, title, done flag, update time, current phase and assignees. Page with first/after — when pageInfo.hasNextPage is true, pass pageInfo.endCursor as after.",
90+
"endpointMapping": {
91+
"method": "query",
92+
"path": "query Cards($pipeId: ID!, $first: Int = 25, $after: String) { allCards(pipeId: $pipeId, first: $first, after: $after) { pageInfo { hasNextPage endCursor } edges { node { id title done updated_at current_phase { id name } assignees { name email } } } } }",
93+
"queryParams": {
94+
"after": "$after",
95+
"first": "$first",
96+
"pipeId": "$pipe_id"
97+
}
98+
},
99+
"name": "pipefy_list_cards",
100+
"parameters": {
101+
"properties": {
102+
"after": {
103+
"description": "Cursor for the next page: the pageInfo.endCursor of the previous call. Omit for the first page.",
104+
"type": "string"
105+
},
106+
"first": {
107+
"description": "Cards per page (default 25, max 50 — the most Pipefy returns per request).",
108+
"maximum": 50,
109+
"minimum": 1,
110+
"type": "integer"
111+
},
112+
"pipe_id": {
113+
"description": "Pipe id, e.g. \"301234567\". pipefy_list_pipes lists them.",
114+
"type": "string"
115+
}
116+
},
117+
"required": [
118+
"pipe_id"
119+
],
120+
"type": "object"
121+
}
122+
},
123+
{
124+
"description": "Show one card in full: id, title, done flag, its pipe and current phase, every field with its name and value, and the assignees.",
125+
"endpointMapping": {
126+
"method": "query",
127+
"path": "query Card($cardId: ID!) { card(id: $cardId) { id title done updated_at pipe { id name } current_phase { id name } fields { name value filled_at } assignees { name email } } }",
128+
"queryParams": {
129+
"cardId": "$card_id"
130+
}
131+
},
132+
"name": "pipefy_get_card",
133+
"parameters": {
134+
"properties": {
135+
"card_id": {
136+
"description": "Card id, e.g. \"123456789\" (the number in the card URL).",
137+
"type": "string"
138+
}
139+
},
140+
"required": [
141+
"card_id"
142+
],
143+
"type": "object"
144+
}
145+
},
146+
{
147+
"description": "Show one phase: id, name, how many cards it holds, and the fields defined on it.",
148+
"endpointMapping": {
149+
"method": "query",
150+
"path": "query Phase($phaseId: ID!) { phase(id: $phaseId) { id name cards_count fields { id label } } }",
151+
"queryParams": {
152+
"phaseId": "$phase_id"
153+
}
154+
},
155+
"name": "pipefy_get_phase",
156+
"parameters": {
157+
"properties": {
158+
"phase_id": {
159+
"description": "Phase id, e.g. \"12345678\". pipefy_get_pipe lists a pipe's phases.",
160+
"type": "string"
161+
}
162+
},
163+
"required": [
164+
"phase_id"
165+
],
166+
"type": "object"
167+
}
168+
}
169+
]
170+
}

‎packages/backend/src/adapters/intl/pipefy.live.spec.ts‎

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -90,14 +90,24 @@ describe('pipefy adapter — static spec conformance', () => {
9090
});
9191
});
9292

93-
// Opt-in live check. Needs a real token; skipped in CI.
94-
const live = process.env.RUN_PIPEFY_LIVE === '1';
95-
(live ? describe : describe.skip)('pipefy — live', () => {
96-
it('is exercised through the connector install + probe flow', () => {
97-
// The adapter's own probe tool is the contract worth checking against a
98-
// real token: `npm run start:dev`, install the adapter, and confirm
99-
// Pipefy answers. Asserting an HTTP shape here would only restate
100-
// the static expectations above against a credential CI does not have.
101-
expect(a.probe?.tool ?? toolNames[0]).toBeTruthy();
102-
});
93+
// Opt-in live check. Needs a real token; skipped in CI by design.
94+
const live =
95+
process.env.RUN_PIPEFY_LIVE === '1' && process.env.PIPEFY_API_TOKEN
96+
? describe
97+
: describe.skip;
98+
live('pipefy — live (read-only)', () => {
99+
it('lists organizations through the real GraphQL API', async () => {
100+
const res = await fetch(a.connector.baseUrl, {
101+
method: 'POST',
102+
headers: {
103+
'Content-Type': 'application/json',
104+
Authorization: `Bearer ${process.env.PIPEFY_API_TOKEN}`,
105+
},
106+
body: JSON.stringify({ query: '{ organizations { id name } }' }),
107+
});
108+
const json = (await res.json()) as {
109+
data?: { organizations?: unknown };
110+
};
111+
expect(Array.isArray(json.data?.organizations)).toBe(true);
112+
}, 60_000);
103113
});

0 commit comments

Comments
 (0)