Skip to main content
Glama

Set Custom Data

set_custom_data
Idempotent

Store private per-user key-value JSON data on a Canvas account for app settings or preferences, replacing any value at the same namespace and scope; retrieve it with the companion getter.

Instructions

Store your own key-value data on your Canvas account (a small private per-user store, invisible to others). Overwrites any existing value at the same namespace and scope. Read it back with get_custom_data.

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": {
      "data": "<data>"
    },
    "name": "set_custom_data"
  }
}

Input Schema

NameRequiredDescriptionDefault
dataYesJSON object to store, e.g. {"theme": "dark"}. Replaces whatever is already stored at this scope.
scopeNoOptional path inside the namespace, e.g. "settings/theme".
namespaceNoNamespace that keeps your data apart from other apps. Defaults to "canvas-mcp".

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv1.0.2
    • changedInput schema / properties / data / description
      Previous value: -"Object to store"New value: +"JSON object to store, e.g. {\"theme\": \"dark\"}. Replaces whatever is already stored at this scope."
    • addedInput schema / properties / namespace / description
      Added value: +"Namespace that keeps your data apart from other apps. Defaults to \"canvas-mcp\"."
    • addedInput schema / properties / scope / description
      Added value: +"Optional path inside the namespace, e.g. \"settings/theme\"."
  2. First observedv1.0.1

TDQS

A4.2/5.0
Behavior4/5

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

Beyond the annotations (readOnly=false, idempotent=true, destructive=false), the description discloses the two behaviors an agent most needs: values are private to the user, and an existing value at the same namespace and scope is overwritten. This explains how the idempotentHint manifests in practice. It does not cover size limits or error behavior, keeping it below 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.

Conciseness5/5

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

Three short sentences, front-loaded with the core action and the privacy guarantee, then the overwrite caveat, then the read-back pointer. No filler, and each sentence delivers distinct information.

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 three-parameter mutation tool with no output schema and full schema coverage, the description supplies the key extras: privacy scope, overwrite semantics, and the companion read tool. Details such as data size limits or what the response confirms are absent but are minor for correct invocation.

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%, with each of the three parameters documented including an example for data and a default for namespace, so the schema carries the load. The description adds only the notion that overwriting is scoped by namespace and scope, which the schema already conveys. Baseline 3 is appropriate.

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 (store) and resource (own key-value data on the Canvas account), and delimits it as 'a small private per-user store, invisible to others.' This is directly distinguishable from the sibling get_custom_data, which is explicitly named as the read counterpart.

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 description gives clear context for use (persisting private per-user data) and routes the agent to get_custom_data for reading it back. It stops short of saying when an agent should prefer this store at all, or any conditions to avoid it, so it falls just short of explicit when/when-not guidance.

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

Deploy Server

Other Tools