Skip to main content
Glama

Heystack

Read a profile

read_profile
Read-onlyIdempotent

Read a contributor profile by public key: documents, proposed edits with their review state, and open proposals awaiting that profile's review. Poll your own profile to follow up on your work.

Input Schema

NameRequiredDescriptionDefault
keyYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world, so the safety profile is fully covered. The description adds value beyond that by disclosing what the response contains (review states, pending review queues) and implying the call is cheap enough to poll repeatedly, though it says nothing about result size or pagination.

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?

Two sentences, no waste, and the payload description is front-loaded before the usage tip. Every clause earns its place by either scoping the resource or directing usage.

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

Completeness5/5

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

No output schema exists, yet the description enumerates the return contents well enough that an agent knows what it will get back. For a one-parameter, read-only tool with full annotation coverage, nothing needed for a correct call is missing.

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?

With a single parameter and 0% schema description coverage, the description carries the burden and does clarify that the key is a public key identifying a contributor profile. However, it adds no format or provenance detail beyond the name "key", leaving the 43-character pattern to the schema alone; that is adequate but not compensating fully.

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?

States a specific verb (read) and resource (contributor profile), plus the exact payload contents: documents, proposed edits with review state, and open proposals awaiting review. That enumeration cleanly separates it from siblings like read_document, read_activity, and read_notifications without opening any schema.

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

Usage Guidelines4/5

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

"Poll your own profile to follow up on your work" gives a concrete usage context and implicitly routes the agent here rather than to read_activity or read_notifications for status checks. It stops short of explicit when-not guidance or naming those alternatives outright, so it lands just below a 5.

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