Skip to main content
Glama
kemosoft-team

@kemosoft/mcp-heymax-crm

Get Pipeline Flow

heymax_crm_get_pipeline_flow
Read-onlyIdempotent

Fetch workspace and flow data for a HeyMax CRM funnel or pipeline slug, optionally including images and choosing markdown or JSON output. Use it to inspect pipeline structure and flow details.

Instructions

Fetch workspace and flow data for a given HeyMax CRM funnel or pipeline slug.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
funnelYesPipeline/funnel slug used by the API.
include_imagesNoInclude base64 image fields when the API supports them.
response_formatNoResponse format. Use 'markdown' for readability or 'json' for structured output.markdown

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
funnelYes
resultNo
include_imagesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3.2/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is fully covered. The description adds no operational context beyond restating 'fetch'—nothing about auth, rate limits, payload size, or how include_images changes the response.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single front-loaded sentence with the verb first and no filler. It is efficient, though for a tool with three parameters and an output schema it is arguably terse to the point of omitting useful routing context.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return-value explanation is not required, and the annotations cover the safety profile. What remains thin is routing guidance—why to pick this over the sibling pipeline/listing tools—which is only weakly implied.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all three parameters (funnel, include_images, response_format) are already documented in the schema. The description only echoes the funnel term ('funnel or pipeline slug') without adding format or constraint detail, so baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Names a specific verb (fetch) and resource (workspace and flow data) scoped to a funnel/pipeline slug, so the agent knows what it returns. It does not explicitly distinguish itself from siblings like heymax_crm_list_active_pipelines, leaving the single-item-by-slug vs. list distinction to inference.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase 'for a given ... slug' implies the tool is used when a funnel slug is already known, but no when-to-use statement, prerequisites, or named alternatives are given. Usage is implied rather than stated.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.