Skip to main content
Glama

Check document engagement

get_document_stats
Read-only

Use when the user asks whether a shared document has been viewed, when it was last opened, or how readers engaged with it. Returns approximate daily/browser views and engagement aggregates for the most recent 100 visits. Visits are not unique people; active time is approximate. This tool does not return individual reader emails. The owner dashboard shows verified reader email addresses in Reader activity; anonymous visits remain unidentified and cannot be retroactively identified. The owner dashboard also supports optional pre-view name/email/phone capture (self-reported, not verified), passcodes and expiration. Selected capture fields must be completed before content is shown. Public mode plus email capture collects an email without requiring sign-in; verified/specific modes still require verified sign-in; use the dedicated reader-settings and explicit-request activity/lead tools to manage these controls in chat.

Input Schema

NameRequiredDescriptionDefault
idYesUUID of an existing document owned by the connected SharedBrief account, returned by document creation or listing.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / id / description
      Added value: +"UUID of an existing document owned by the connected SharedBrief account, returned by document creation or listing."
  2. First observed

TDQS

A4/5.0
Behavior5/5

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

Annotations already declare readOnly/non-destructive, so the bar is lower, yet the description adds substantial context: results are approximate daily/browser views over the most recent 100 visits, visits are not unique people, active time is approximate, and it does NOT return individual reader emails. This discloses data limits and privacy boundaries the annotations cannot express.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The trigger sentence is well front-loaded, but the back half drifts into owner-dashboard capture modes, passcodes, expiration, and sign-in requirements that this stats tool does not perform. Those lines inflate the definition without helping an agent call get_document_stats correctly.

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 return-value burden and mostly does: it explains what data comes back (approximate views, engagement aggregates) and what it omits (reader emails). A 1-param read tool is adequately specified here, though the tangential dashboard detail crowds the useful content.

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?

Single parameter with 100% schema coverage, so the schema already documents the id fully. The description adds no syntax or format detail about the id and instead spends words on unrelated dashboard features; baseline 3 is appropriate when the schema does the heavy lifting.

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?

State a specific verb/resource: returns how a shared document was viewed, last opened, and reader engagement aggregates. It clearly describes what it returns, but only distinguishes itself from siblings (get_document_activity, get_document_leads, get_document_reader_settings) obliquely at the very end, so the differentiation is not front-and-center.

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?

The opening sentence gives a concrete when-to-use trigger ('user asks whether a shared document has been viewed, when it was last opened, or how readers engaged'). It also routes control-management tasks to 'dedicated reader-settings and explicit-request activity/lead tools,' naming alternatives, though without explicit when-not conditions.

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