Skip to main content
Glama
yenchieh

DiagramZu

by yenchieh
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

list_diagrams

List diagrams across a workspace before creating a new one to avoid duplicates; search titles, descriptions, or code, and sort by creation, update, title, or relevance.

Instructions

List diagrams in the configured Space (every folder, newest first by default). Use this BEFORE create_diagram to check whether a diagram with the target purpose already exists — if it does, prefer update_diagram over creating a duplicate. Filter with q (case-insensitive substring on title, description, or code) when looking for a named diagram (e.g. q: 'schema' or q: 'infra'). Sort with sort: 'updated' to find the most recently changed diagrams, or sort: 'relevance' when q is set so a title hit ranks above a description or code hit.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
qNoCase-insensitive substring search on title, description, or code. Use when looking for a named diagram (e.g. 'schema', 'infra').
sortNoSort order. 'created' (default) = newest-first by creation; 'updated' = newest-first by last edit (use this to find the most recently changed diagram); 'title' = alphabetical; 'relevance' = title hits first, then description, then code (only when `q` is set; otherwise same as 'updated').
ownerNoFilter to diagrams created by this user (Clerk user id, e.g. 'user_abc'). Rarely needed; omit unless the caller already has the user id.
spaceNoWhich workspace to act in: its id, its slug, or its exact name (case-insensitive). Omit to use this token's default workspace. Call list_spaces to see what this token can reach. A name that matches more than one workspace is refused — pass the id or slug instead.
folderIdNoOptional UUID — narrow to diagrams in this folder. Use list_folders to look up folder ids. Omit to see every folder (the default).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.0.7
    • addedInput schema / properties / space
      Added value: +{
+  "description": "Which workspace to act in: its id, its slug, or its exact name (case-insensitive). Omit to use this token's default workspace. Call list_spaces to see what this token can reach. A name that matches more than one workspace is refused — pass the id or slug instead.",
+  "type": "string"
+}
  2. Changed3 schema fields changedv0.0.5
    • changedInput schema / properties / q / description
      Previous value: -"Case-insensitive substring search on title and code. Use when looking for a named diagram (e.g. 'schema', 'infra')."New value: +"Case-insensitive substring search on title, description, or code. Use when looking for a named diagram (e.g. 'schema', 'infra')."
    • changedInput schema / properties / sort / description
      Previous value: -"Sort order. 'created' (default) = newest-first by creation; 'updated' = newest-first by last edit (use this to find the most recently changed diagram); 'title' = alphabetical."New value: +"Sort order. 'created' (default) = newest-first by creation; 'updated' = newest-first by last edit (use this to find the most recently changed diagram); 'title' = alphabetical; 'relevance' = title hits first, then description, then code (only when `q` is set; otherwise same as 'updated')."
    • changedInput schema / properties / sort / enum
      Previous value: -[
-  "created",
-  "updated",
-  "title"
-]New value: +[
+  "created",
+  "updated",
+  "title",
+  "relevance"
+]
  3. First observedv0.0.3

TDQS

A4.3/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does disclose defaults: scope is the whole Space across every folder, and ordering is newest-first by default. It omits result limits, pagination, and any auth/scope caveats, which are meaningful for a list endpoint.

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?

Front-loads the core purpose and default behavior, then layers the pre-create check and filter/sort guidance. It is somewhat long, but each sentence carries actionable routing or parameter guidance.

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?

Covers scope, ordering defaults, and the pre-flight duplicate check for a 5-parameter, all-optional list tool. Given no output schema and no annotations, the omission of pagination/result-size behavior is the remaining gap.

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 coverage is 100%, so both `q` and `sort` are already fully documented in the schema; the description largely restates that (substring match, relevance ranking). It adds only light usage framing rather than new semantics, so 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+resource (list diagrams) plus scope (configured Space, every folder) and the default ordering. It also distinguishes itself from siblings create_diagram and update_diagram by naming them, so an agent can route without opening schemas.

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?

Explicitly instructs to run this BEFORE create_diagram to avoid duplicates and to prefer update_diagram when a match exists. It also names the conditions for using `q` and each `sort` value, leaving little to inference.

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