Skip to main content
Glama
ghl-mcp-server-v2

ghl-mcp-server-v2

by zackscriven

ghl_proposal_list_documents

Read-onlyIdempotent

Lists proposal documents for a specific location, with pagination and filters for status, payment status, dates, and search query.

Instructions

List documents List documents for a location Endpoint: GET /proposals/document (Version header: v3; source: v3/proposals-v3.json) Requires an Agency or Sub-Account token. Pagination params: limit, skip — pass them to page through full result sets.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "locationId": "<locationId>"
    },
    "name": "ghl_proposal_list_documents"
  }
}

Input Schema

NameRequiredDescriptionDefault
skipNoSkip number of records
limitNoLimit to fetch number of records
queryNoSearch string
dateToNoDate to (ISO 8601), dateFrom & DateTo must be provided together
statusNoDocument status, pass as comma separated values
dateFromNoDate start from (ISO 8601), dateFrom & DateTo must be provided together
locationIdYesLocation Id
paymentStatusNoPayment status, pass as comma separated values

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint/idempotent/non-destructive, so the bar is lower; the description still adds real context by naming the required token scope (Agency or Sub-Account) and explaining that limit/skip exist to page through full result sets. It stops short of describing the response shape or ordering, which is the remaining gap.

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

Conciseness3/5

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

The opening 'List documents' line is a redundant restatement of the next sentence and of the annotation title, wasting the most valuable position. The remaining lines (endpoint, auth, pagination) are terse and each carries information.

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?

With eight filter parameters, no output schema, and read-only annotations, the description covers auth and pagination but says nothing about what is returned (document fields, paging metadata) or how the query/status/date/paymentStatus filters combine. The 100% schema coverage compensates for filter semantics, but the return-side gap remains.

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 eight parameters are already documented, including the dateFrom/dateTo pairing and comma-separated enum behavior. The description only reiterates limit/skip with a bit of paging intent, which is marginal added value over the schema.

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?

States a specific verb and resource ('List documents for a location'), which clearly distinguishes it from the sibling send/template tools like ghl_proposal_send_document and ghl_proposal_list_templates. It never explicitly says how it differs from the template-listing tool, but the resource noun is different enough for an agent to route correctly.

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?

Usage is implied by 'for a location' and the pagination note tells the agent how to page, but there is no explicit when-to-use/when-not guidance or named alternative. The auth line ('Requires an Agency or Sub-Account token') is a useful precondition rather than a selection rule.

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

Deploy Server

Other Tools