Skip to main content
Glama

contacts-get_research_by_external_id

Read-onlyIdempotent

Retrieve contact research using an external system ID, such as a HubSpot contact ID, plus the source name.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
externalIdYesThe external identifier of the contact research request (e.g., HubSpot contact ID)
externalSourceYesThe source system that provided the external ID (e.g., "hubspot")

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.4/5.0
Behavior3/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 only that lookup is by external ID and confirms a source name is needed; it does not disclose return format, error behavior for unknown IDs, or rate limits.

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 efficient sentence with the key detail (external system ID) front-loaded. No waste, though it could be slightly tighter.

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?

For a two-parameter read tool with full annotation coverage, the description is adequate to invoke correctly. With no output schema, however, it says nothing about what the returned 'contact research' contains, which is a modest gap.

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%, and both parameters already carry descriptions with the same HubSpot example given in the tool description. The description thus adds no meaning beyond the schema, so the baseline of 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?

States a specific verb ('Retrieve') and resource ('contact research') plus the lookup key ('external system ID'). The 'external system ID' framing functionally distinguishes it from the sibling contacts-get_research (internal ID), though it does not name that sibling explicitly.

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?

It implicitly tells the agent to use this when an external system ID (e.g., HubSpot) is available, which is useful context. However, it never names the alternative contacts-get_research or states when NOT to use this tool, leaving the choice between the two lookup tools to inference.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources