@kemosoft/mcp-heymax-crm
Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| HEYMAX_CRM_API_KEY | Yes | API key for HeyMax CRM | |
| HEYMAX_CRM_API_SOURCE | No | Optional source identifier for API calls |
Instructions
Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.
This server publishes no instructions, or was last inspected before Glama recorded them.
Capabilities
Features and capabilities supported by this server
Protocol revision2025-11-25
| Capability | Details |
|---|---|
| tools | {
"listChanged": true
} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| heymax_crm_list_active_pipelinesB | List active customer service funnels/pipelines configured in the HeyMax CRM API. |
| heymax_crm_list_lost_reasonsB | List available lost or closing reasons for customer service records in the HeyMax CRM API. |
| heymax_crm_list_eventsB | List customer service events available in the HeyMax CRM API. |
| heymax_crm_list_tagsB | List customer service tags configured in the HeyMax CRM API. |
| heymax_crm_validate_phoneB | Validate whether a phone number exists on WhatsApp according to the HeyMax CRM API. |
| heymax_crm_search_address_by_cepC | Resolve a CEP into address data using the HeyMax CRM API. |
| heymax_crm_find_services_by_phoneB | Find existing customer service records by phone number, grouped by CPF in the HeyMax CRM API. |
| heymax_crm_get_pipeline_flowB | Fetch workspace and flow data for a given HeyMax CRM funnel or pipeline slug. |
| heymax_crm_get_service_status_by_idB | Fetch the current status of a customer service record by atendimento ID. |
| heymax_crm_get_service_status_by_funnel_and_cpfB | Fetch the current status of a customer service record by funnel slug and CPF. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
TDQS
Scored across 10 tools
Each tool targets a distinct action or resource, but two tools retrieve pipeline data (list_active_pipelines vs get_pipeline_flow) and two fetch service status by different keys, which could cause slight confusion. The descriptions help differentiate them, so the overlap is minor.
All tools share the 'heymax_crm_' prefix and follow a consistent snake_case verb_noun pattern (e.g., list_, get_, find_, validate_). The verb variations are appropriate to each action, maintaining predictable naming throughout.
With 10 tools, the set is well-scoped for a CRM integration, covering metadata listing, validation, lookup, and status retrieval without bloat. Each tool appears to earn its place.
The surface is largely read-only: it can list metadata, validate phone numbers, search addresses, and fetch service status, but lacks operations to create, update, or delete service records, tags, or pipelines. This leaves notable gaps for a CRM integration, though core read workflows are covered.