Skip to main content
Glama

Read collaboration note

get_collaboration_note
Read-onlyIdempotent

Read an exact collaboration note and its Pretext documents after checking inherited access.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
noteIdYes
workspaceIdYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleYes
noteIdYes
isOwnerYes
ownerIdYes
markdownYes
revisionYes
updatedAtYes
publicPageYes
workspaceIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and idempotentHint=true, so the description adds value by mentioning that inherited access is checked before returning data and that the response includes Pretext documents. This gives the agent useful behavioral context beyond the structured annotations.

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?

The description is a single, tightly worded sentence that places the core action and resource first. Every phrase earns its place by adding scope or behavioral nuance.

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 simple read operation with a rich output schema and safety annotations, the description covers the essential distinguishing behavior: returning Pretext documents and checking inherited access. It could further clarify what 'inherited access' means or how access failures are surfaced, but it is otherwise adequate.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description needed to compensate by explaining how noteId and workspaceId relate to the operation. It does not; it only restates the general read action. The parameter names are fairly self-explanatory, but the description itself adds little semantic value for the inputs.

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?

The description states a clear action ('Read') and a specific resource ('an exact collaboration note and its Pretext documents'), which is more informative than the title alone. It does not explicitly differentiate from sibling tools like get_note, but the collaboration-specific scope makes the purpose reasonably distinct.

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

Usage Guidelines2/5

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

The description gives no explicit guidance on when to use this tool versus alternatives such as get_note or list_shared_with_me. It implies a read use case but provides no exclusions, conditions, or comparison to sibling tools.

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