Skip to main content
Glama

Read a profile

heystack_read_profile
Read-onlyIdempotent

Read a contributor profile by public key: documents, proposed edits and their review state, and inbox (open suggestions waiting for that profile). Use this to follow up on a known public key. Do not use it to search documents. Review inbox items with heystack_review_suggestion.

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": {
      "key": "<key>"
    },
    "name": "heystack_read_profile"
  }
}

Input Schema

NameRequiredDescriptionDefault
keyYesContributor public key. Never a private key.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.2/5.0
Behavior3/5

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

Annotations already cover the safety profile fully (readOnly, idempotent, non-destructive, closed-world), so the bar is lower. The description adds real value by disclosing what the read returns — documents, edits and their review state, open suggestions in the inbox — which annotations cannot convey. It stops short of noting permissions, visibility rules, or result size, so it is solid but not rich.

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?

Three tight sentences, front-loaded with the action and payload, then usage scope, then the alternative tool. No filler or restated name/title content.

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 single-parameter read tool with full schema coverage and complete annotations, the definition covers purpose, scope, and returned data. Only minor gaps remain — no output schema exists and the description does not sketch the shape or volume of the returned profile data — but nothing essential to correct invocation 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 100% schema coverage and a single parameter, the schema already documents the key, its format pattern, and the "Never a private key" caveat. The description only restates that lookup is by public key, adding no format or meaning beyond the schema; baseline 3 applies.

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 and resource ("Read a contributor profile by public key") and enumerates the payload: documents, proposed edits with review state, and inbox. It explicitly disclaims the nearest sibling use case ("Do not use it to search documents"), so an agent can distinguish it from heystack_search_documents without opening the schema.

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

Usage Guidelines5/5

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

Gives an explicit when-to-use condition ("follow up on a known public key"), an explicit when-not ("Do not use it to search documents"), and names the follow-up tool for inbox items (heystack_review_suggestion). Little is left 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