Skip to main content
Glama

chatwoot_search_contacts

Read-only

Find customer contacts in Chatwoot by searching name, email, phone, or identifier. Retrieve matching contact details and account info for support and analytics.

Instructions

Searches contacts by name, email, phone, or identifier.

Args:
    query: Text to search (name, email, phone, or identifier).
    page: Results page.
    output_format: Output format.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNo
queryYes
output_formatNomarkdown

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so safety is covered. The description adds useful context by listing which contact fields can be searched, but it does not disclose matching behavior (e.g., partial vs. exact, case sensitivity) or pagination behavior beyond a 'page' parameter.

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?

The description is compact and front-loaded with the main purpose, followed by a brief argument list. The only minor issue is slight redundancy: the first sentence repeats what the 'query' argument line says.

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

Completeness4/5

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

For a simple search tool with a small parameter set, output schema present, and read-only annotations, the description gives enough information to understand what the tool searches and what the key argument means. It lacks alternative-routing guidance and behavioral specifics, but nothing critical is missing for basic invocation.

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 0%, so the description must compensate. It does well for 'query' by explaining it matches name, email, phone, or identifier. However, 'page' is only described as 'Results page' and 'output_format' is simply 'Output format', adding little beyond the schema titles and enum.

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

Purpose5/5

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

The description opens with a specific verb and resource: 'Searches contacts'. It also enumerates the searchable attributes (name, email, phone, or identifier), which makes the tool's scope clear and distinguishes it from sibling tools like chatwoot_get_contact or chatwoot_search_conversations.

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 use case is implied by the name and description: use this tool to search contacts. However, there is no explicit guidance about when to prefer it over chatwoot_get_contact or other contact-related siblings, and no mention of alternatives or exclusions.

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