Skip to main content
Glama

Read document activity

heystack_read_activity
Read-onlyIdempotent

Read suggestions, published revisions, or the discussion on one public document. Use this to see proposed edits (state open, merged or rejected, with mergeContent and any mergeError) or comments. Do not use it to read the document body. The owner reviews an open suggestion with heystack_review_suggestion.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "heystack_read_activity"
  }
}

Input Schema

NameRequiredDescriptionDefault
idNoDocument id, a UUID or a legacy number. A /doc/ URL in this field is accepted. Kept for existing clients.
urlNoPublic document URL, such as https://heystacks.com/doc/{id}/{slug} or that path plus .md.
pageNoPage number, starting at 1.
slugNoDocument slug from the URL. If several documents share it, the call returns their URLs.
surfaceNoactivity returns suggestions and published revisions. discussion returns comments and tasks.activity

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

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 covered. The description adds real behavioral detail beyond that: suggestion lifecycle states (open, merged, rejected) and the presence of mergeContent and mergeError in results. It does not mention pagination behavior despite a page parameter, which keeps it short of a 5.

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?

Three short sentences, front-loaded with the resource list, then the exclusion, then the sibling handoff — no filler. Minor redundancy: the discussion/comments coverage restates what the surface enum already says, and the mergeContent/mergeError parenthetical reads like return-field documentation.

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?

With no output schema, the description carries the burden of describing returns, and it does sketch them (suggestion states, mergeContent, mergeError, comments, tasks). Coverage of paging and the exact response envelope is absent, but for a read-only tool whose safety profile is fully annotated, an agent has enough to call it correctly.

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 id, url, slug, page and the surface enum are all documented in the schema itself, including fallback behavior and multi-match slug handling. The description adds no parameter-level meaning beyond that — the open/merged/rejected states it mentions are output concepts, not inputs. 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 ('read') and concrete resources ('suggestions, published revisions, or the discussion'), scoped to 'one public document'. It also draws an explicit boundary against the closest sibling: 'Do not use it to read the document body' clearly separates it from heystack_read_document.

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 when-to-use ('see proposed edits ... or comments'), an explicit exclusion ('Do not use it to read the document body'), and routes the adjacent workflow to a named alternative ('The owner reviews an open suggestion with heystack_review_suggestion'). The selection decision is fully resolved in the description.

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