Skip to main content
Glama

canvas_get_conversation

Read-only

Retrieve a full Canvas conversation thread with all messages. Read-only, so it does not mark the conversation as read.

Instructions

Get a full Canvas conversation thread with all messages. Read-only: does not mark the conversation as read.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
viewNoResponse shape: "compact" (default) drops fields the response already carries elsewhere; "full" returns every field this server understands. compact removes the avatar URLs Canvas attaches to user objects (avatar_url, avatar_image_url); "full" returns Canvas's payload untouched. Link fields (url, html_url, preview_url) survive both rungs. No field projection: this server passes Canvas's payload through verbatim and has no verified record of which of its fields a caller needs.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.0.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. Changed1 schema field changedv1.5.4
    • addedInput schema / properties / view
      Added value: +{
      +  "description": "Response shape: \"compact\" (default) drops fields the response already carries elsewhere; \"full\" returns every field this server understands. compact removes the avatar URLs Canvas attaches to user objects (avatar_url, avatar_image_url); \"full\" returns Canvas's payload untouched. Link fields (url, html_url, preview_url) survive both rungs. No field projection: this server passes Canvas's payload through verbatim and has no verified record of which of its fields a caller needs.",
      +  "enum": [
      +    "compact",
      +    "full"
      +  ],
      +  "type": "string"
      +}
  3. Addedv1.2.5

TDQS

A4/5.0
Behavior4/5

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

The readOnlyHint annotation already marks this as a read-only operation, and the description adds a useful specific behavior: it does not mark the conversation as read. This is a non-obvious side-effect guarantee that goes beyond the annotation and helps an agent avoid assuming a GET request will update read state.

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 short sentences, front-loaded with the core purpose and then the important read-state behavior. Every phrase earns its place, and the description avoids repeating schema details already present in the view parameter.

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-only single-resource tool with no output schema, the description plus the detailed view parameter docs provide enough to call it correctly. The main gap is the lack of explicit id semantics, but the tool name and 'conversation thread' phrasing make the intended usage fairly clear.

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?

The view parameter is richly documented in the schema, so no additional description is needed there. However, the required id parameter has no schema description, and the tool description only loosely implies it is the conversation ID without stating the expected format or providing explicit confirmation.

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?

The description states a specific verb and resource: 'Get a full Canvas conversation thread with all messages.' This makes the tool's purpose immediately distinguishable from sibling list tools like canvas_list_conversations, which enumerate conversations rather than returning a single thread.

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

Usage Guidelines3/5

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

The description implies the tool should be used when a caller needs the complete thread for one conversation, but it never explicitly names canvas_list_conversations as the alternative or states when not to use this tool. The guidance is present only by implication, relying on the sibling tool names for context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.