Skip to main content
Glama
AIWerk

@aiwerk/mcp-server-ghl

by AIWerk

conversations_export_messages_by_location

Read-onlyIdempotent

Export GoHighLevel messages by location ID, filtering by channel, date range, contact, or conversation. Use cursor pagination to retrieve large message sets efficiently.

Instructions

Export messages by location ID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoNumber of messages to return per page
cursorNoCursor for pagination. Pass the nextCursor from previous response to get next page.
sortByNoField to sort by
channelNoFilter by message channel. If not provided, all non-email message types will be returned including activity messages (opportunity updates, appointments, etc.)
endDateNoEnd date to filter messages by
contactIdNoFilter messages by contact ID
sortOrderNoSort order
startDateNoStart date to filter messages by
locationIdNoLocation ID to filter messages by Defaults to GHL_LOCATION_ID when omitted.
conversationIdNoFilter messages by conversation ID
Behavior2/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, which covers safety. The description adds no behavioral context—no mention of pagination behavior (cursor), default channel filtering (implied in schema), or what happens when locationId is omitted (defaults to GHL_LOCATION_ID). The one-liner offers nothing beyond annotations.

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

Conciseness5/5

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

A single concise sentence that is front-loaded with the core action and scope. No wasted words. Efficient and easily parsed.

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

Completeness2/5

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

For a tool with 10 optional parameters and no output schema, the description is severely under-specified. It doesn't explain what 'export' means (versus 'get'), how results are returned, whether there are any caveats, or how pagination works. The agent must rely entirely on the schema, which is unusual. A robust tool with this many filters should have more context.

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%, with each parameter having a description (e.g., channel filter behavior, cursor pagination). The description itself doesn't reference any parameters or add meaning beyond the schema. Baseline 3 is appropriate as the schema carries the full burden.

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?

The description states a specific verb ('Export') and resource ('messages') with a clear scope ('by location ID'). It's clear what the tool does, but it doesn't differentiate from sibling tools like conversations_get_messages or conversations_search_conversation, which also deal with messages. The name itself is descriptive, but the one-liner adds little beyond the name.

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

Usage Guidelines2/5

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

No guidance on when to use this tool versus alternatives. It doesn't mention conditions, exclusions, or alternatives. An agent would not know if this is preferred over conversations_get_messages for specific use cases, or when to filter by channel or paginate. The description offers no decision support.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/AIWerk/mcp-server-ghl'

If you have feedback or need assistance with the MCP directory API, please join our Discord server