Skip to main content
Glama

read_document

Read-onlyIdempotent

Read one document by UUID. Choose detail for content and metadata, markdown for portable export, or versions for saved revisions and snapshots. All views are read-only.

Instructions

Read one document by UUID. Choose detail for content and metadata, markdown for portable export, or versions for saved revisions and snapshots. All views are read-only.

Input Schema

NameRequiredDescriptionDefault
idNoUUID returned by the corresponding list or read operation.
viewNo
workspaceIdNoWorkspace UUID from list_workspace_structure(kind=workspaces). Required for ambiguous creates and structure changes; omit to search all granted scopes.
onlySnapshotsNoWhen true, return only named snapshots.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv2.1.1
    • removedInput schema / properties / id / anyOf
      Removed value: -[
      -  {
      -    "description": "UUID returned by the corresponding list or read operation.",
      -    "format": "uuid",
      -    "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      -    "type": "string"
      -  },
      -  {
      -    "description": "UUID returned by the corresponding list or read operation.",
      -    "format": "uuid",
      -    "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      -    "type": "string"
      -  },
      -  {
      -    "description": "UUID returned by the corresponding list or read operation.",
      -    "format": "uuid",
      -    "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      -    "type": "string"
      -  }
      -]
    • addedInput schema / properties / id / description
      Added value: +"UUID returned by the corresponding list or read operation."
    • addedInput schema / properties / id / format
      Added value: +"uuid"
    • addedInput schema / properties / id / pattern
      Added value: +"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    • addedInput schema / properties / id / type
      Added value: +"string"
    • changedOutput schema / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "operation": {
      -        "const": "detail",
      -        "type": "string"
      -      },
      -      "result": {
      -        "additionalProperties": {},
      -        "properties": {
      -          "categoryId": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          },
      -          "content": {
      -            "type": "string"
      -          },
      -          "contentJson": {},
      -          "createdAt": {
      -            "type": "string"
      -          },
      -          "folderId": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          },
      -          "folderName": {
      -            "type": [
      -              "string",
      -              "null"
      -            ]
      -          },
      -          "id": {
      -            "type": "string"
      -          },
      -          "metadata": {},
      -          "ownerId": {
      -            "type": "string"
      -          },
      -          "tags": {
      -            "items": {
      -              "additionalProperties": {},
      -              "properties": {
      -                "color": {
      -                  "type": [
      -                    "string",
      -                    "null"
      -                  ]
      -                },
      -                "createdAt": {
      -                  "type": "string"
      -                },
      -                "documentCount": {
      -                  "type": "number"
      -                },
      -                "id": {
      -                  "type": "string"
      -                },
      -                "name": {
      -                  "type": "string"
      -                }
      -              },
      -              "required": [
      -                "id",
      -                "name",
      -                "color"
      -              ],
      -              "type": "object"
      -            },
      -            "type": "array"
      -          },
      -          "title": {
      -            "type": "string"
      -          },
      -          "updatedAt": {
      -            "type": "string"
      -          },
      -          "visibility": {
      -            "enum": [
      -              "private",
      -              "shared",
      -              "public"
      -            ],
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "id",
      -          "ownerId",
      -          "folderId",
      -          "categoryId",
      -          "title",
      -          "content",
      -          "visibility",
      -          "createdAt",
      -          "updatedAt"
      -        ],
      -        "type": "object"
      -      }
      -    },
      -    "required": [
      -      "operation",
      -      "result"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "operation": {
      -        "const": "markdown",
      -        "type": "string"
      -      },
      -      "result": {
      -        "additionalProperties": {},
      -        "properties": {
      -          "filename": {
      -            "type": "string"
      -          },
      -          "markdown": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "markdown"
      -        ],
      -        "type": "object"
      -      }
      -    },
      -    "required": [
      -      "operation",
      -      "result"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "operation": {
      -        "const": "versions",
      -        "type": "string"
      -      },
      -      "result": {
      -        "items": {
      -          "additionalProperties": {},
      -          "properties": {
      -            "content": {
      -              "type": "string"
      -            },
      -            "contentJson": {},
      -            "createdAt": {
      -              "type": "string"
      -            },
      -            "createdBy": {
      -              "type": "string"
      -            },
      -            "description": {
      -              "type": [
      -                "string",
      -                "null"
      -              ]
      -            },
      -            "documentId": {
      -              "type": "string"
      -            },
      -            "id": {
      -              "type": "string"
      -            },
      -            "isSnapshot": {
      -              "type": "boolean"
      -            },
      -            "label": {
      -              "type": [
      -                "string",
      -                "null"
      -              ]
      -            },
      -            "restoredFrom": {
      -              "type": [
      -                "string",
      -                "null"
      -              ]
      -            }
      -          },
      -          "required": [
      -            "id",
      -            "documentId",
      -            "content",
      -            "createdBy",
      -            "createdAt"
      -          ],
      -          "type": "object"
      -        },
      -        "type": "array"
      -      }
      -    },
      -    "required": [
      -      "operation",
      -      "result"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "operation": {
      +        "const": "detail",
      +        "type": "string"
      +      },
      +      "result": {
      +        "additionalProperties": {},
      +        "properties": {
      +          "categoryId": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "content": {
      +            "type": "string"
      +          },
      +          "contentJson": {},
      +          "createdAt": {
      +            "type": "string"
      +          },
      +          "folderId": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "folderName": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "id": {
      +            "type": "string"
      +          },
      +          "metadata": {},
      +          "ownerId": {
      +            "type": "string"
      +          },
      +          "tags": {
      +            "items": {
      +              "additionalProperties": {},
      +              "properties": {
      +                "color": {
      +                  "type": [
      +                    "string",
      +                    "null"
      +                  ]
      +                },
      +                "createdAt": {
      +                  "type": "string"
      +                },
      +                "documentCount": {
      +                  "type": "number"
      +                },
      +                "id": {
      +                  "type": "string"
      +                },
      +                "name": {
      +                  "type": "string"
      +                }
      +              },
      +              "required": [
      +                "id",
      +                "name",
      +                "color"
      +              ],
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "title": {
      +            "type": "string"
      +          },
      +          "updatedAt": {
      +            "type": "string"
      +          },
      +          "visibility": {
      +            "enum": [
      +              "private",
      +              "shared",
      +              "public"
      +            ],
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "id",
      +          "ownerId",
      +          "folderId",
      +          "categoryId",
      +          "title",
      +          "content",
      +          "visibility",
      +          "createdAt",
      +          "updatedAt"
      +        ],
      +        "type": "object"
      +      }
      +    },
      +    "required": [
      +      "operation",
      +      "result"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "operation": {
      +        "const": "markdown",
      +        "type": "string"
      +      },
      +      "result": {
      +        "additionalProperties": {},
      +        "properties": {
      +          "filename": {
      +            "type": "string"
      +          },
      +          "id": {
      +            "type": "string"
      +          },
      +          "markdown": {
      +            "type": "string"
      +          },
      +          "title": {
      +            "type": "string"
      +          },
      +          "updatedAt": {
      +            "type": "string"
      +          },
      +          "url": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "workspaceId": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "workspaceSlug": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          }
      +        },
      +        "required": [
      +          "markdown"
      +        ],
      +        "type": "object"
      +      }
      +    },
      +    "required": [
      +      "operation",
      +      "result"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "operation": {
      +        "const": "versions",
      +        "type": "string"
      +      },
      +      "result": {
      +        "items": {
      +          "additionalProperties": {},
      +          "properties": {
      +            "content": {
      +              "type": "string"
      +            },
      +            "contentJson": {},
      +            "createdAt": {
      +              "type": "string"
      +            },
      +            "createdBy": {
      +              "type": "string"
      +            },
      +            "description": {
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            },
      +            "documentId": {
      +              "type": "string"
      +            },
      +            "id": {
      +              "type": "string"
      +            },
      +            "isSnapshot": {
      +              "type": "boolean"
      +            },
      +            "label": {
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            },
      +            "restoredFrom": {
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            }
      +          },
      +          "required": [
      +            "id",
      +            "documentId",
      +            "content",
      +            "createdBy",
      +            "createdAt"
      +          ],
      +          "type": "object"
      +        },
      +        "type": "array"
      +      }
      +    },
      +    "required": [
      +      "operation",
      +      "result"
      +    ],
      +    "type": "object"
      +  }
      +]
  2. Changed3 schema fields changedv2.0.4
    • changedInput schema / oneOf
      Previous value: -[
      -  {
      -    "allOf": [
      -      {
      -        "not": {
      -          "anyOf": [
      -            {
      -              "required": [
      -                "onlySnapshots"
      -              ]
      -            }
      -          ]
      -        }
      -      }
      -    ],
      -    "properties": {
      -      "id": {
      -        "description": "UUID returned by the corresponding list or read operation.",
      -        "format": "uuid",
      -        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      -        "type": "string"
      -      },
      -      "view": {
      -        "const": "detail",
      -        "description": "Select the detail operation explicitly.",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "view",
      -      "id"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "allOf": [
      -      {
      -        "not": {
      -          "anyOf": [
      -            {
      -              "required": [
      -                "onlySnapshots"
      -              ]
      -            }
      -          ]
      -        }
      -      }
      -    ],
      -    "properties": {
      -      "id": {
      -        "description": "UUID returned by the corresponding list or read operation.",
      -        "format": "uuid",
      -        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      -        "type": "string"
      -      },
      -      "view": {
      -        "const": "markdown",
      -        "description": "Select the markdown operation explicitly.",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "view",
      -      "id"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "id": {
      -        "description": "UUID returned by the corresponding list or read operation.",
      -        "format": "uuid",
      -        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      -        "type": "string"
      -      },
      -      "onlySnapshots": {
      -        "description": "When true, return only named snapshots.",
      -        "type": "boolean"
      -      },
      -      "view": {
      -        "const": "versions",
      -        "description": "Select the versions operation explicitly.",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "view",
      -      "id"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "allOf": [
      +      {
      +        "not": {
      +          "anyOf": [
      +            {
      +              "required": [
      +                "onlySnapshots"
      +              ]
      +            }
      +          ]
      +        }
      +      }
      +    ],
      +    "properties": {
      +      "id": {
      +        "description": "UUID returned by the corresponding list or read operation.",
      +        "format": "uuid",
      +        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +        "type": "string"
      +      },
      +      "view": {
      +        "const": "detail",
      +        "description": "Select the detail operation explicitly.",
      +        "type": "string"
      +      },
      +      "workspaceId": {
      +        "$schema": "https://json-schema.org/draft/2020-12/schema",
      +        "description": "Workspace UUID from list_workspace_structure(kind=workspaces). Required for ambiguous creates and structure changes; omit to search all granted scopes.",
      +        "format": "uuid",
      +        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "view",
      +      "id"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "allOf": [
      +      {
      +        "not": {
      +          "anyOf": [
      +            {
      +              "required": [
      +                "onlySnapshots"
      +              ]
      +            }
      +          ]
      +        }
      +      }
      +    ],
      +    "properties": {
      +      "id": {
      +        "description": "UUID returned by the corresponding list or read operation.",
      +        "format": "uuid",
      +        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +        "type": "string"
      +      },
      +      "view": {
      +        "const": "markdown",
      +        "description": "Select the markdown operation explicitly.",
      +        "type": "string"
      +      },
      +      "workspaceId": {
      +        "$schema": "https://json-schema.org/draft/2020-12/schema",
      +        "description": "Workspace UUID from list_workspace_structure(kind=workspaces). Required for ambiguous creates and structure changes; omit to search all granted scopes.",
      +        "format": "uuid",
      +        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "view",
      +      "id"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "id": {
      +        "description": "UUID returned by the corresponding list or read operation.",
      +        "format": "uuid",
      +        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +        "type": "string"
      +      },
      +      "onlySnapshots": {
      +        "description": "When true, return only named snapshots.",
      +        "type": "boolean"
      +      },
      +      "view": {
      +        "const": "versions",
      +        "description": "Select the versions operation explicitly.",
      +        "type": "string"
      +      },
      +      "workspaceId": {
      +        "$schema": "https://json-schema.org/draft/2020-12/schema",
      +        "description": "Workspace UUID from list_workspace_structure(kind=workspaces). Required for ambiguous creates and structure changes; omit to search all granted scopes.",
      +        "format": "uuid",
      +        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "view",
      +      "id"
      +    ],
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / workspaceId
      Added value: +{
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "description": "Workspace UUID from list_workspace_structure(kind=workspaces). Required for ambiguous creates and structure changes; omit to search all granted scopes.",
      +  "format": "uuid",
      +  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +  "type": "string"
      +}
    • changedOutput schema / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "operation": {
      -        "const": "detail",
      -        "type": "string"
      -      },
      -      "result": {
      -        "additionalProperties": {},
      -        "properties": {
      -          "categoryId": {
      -            "anyOf": [
      -              {
      -                "type": "string"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "content": {
      -            "type": "string"
      -          },
      -          "contentJson": {},
      -          "createdAt": {
      -            "type": "string"
      -          },
      -          "folderId": {
      -            "anyOf": [
      -              {
      -                "type": "string"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "folderName": {
      -            "anyOf": [
      -              {
      -                "type": "string"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "id": {
      -            "type": "string"
      -          },
      -          "metadata": {},
      -          "ownerId": {
      -            "type": "string"
      -          },
      -          "tags": {
      -            "items": {
      -              "additionalProperties": {},
      -              "properties": {
      -                "color": {
      -                  "anyOf": [
      -                    {
      -                      "type": "string"
      -                    },
      -                    {
      -                      "type": "null"
      -                    }
      -                  ]
      -                },
      -                "createdAt": {
      -                  "type": "string"
      -                },
      -                "documentCount": {
      -                  "type": "number"
      -                },
      -                "id": {
      -                  "type": "string"
      -                },
      -                "name": {
      -                  "type": "string"
      -                }
      -              },
      -              "required": [
      -                "id",
      -                "name",
      -                "color"
      -              ],
      -              "type": "object"
      -            },
      -            "type": "array"
      -          },
      -          "title": {
      -            "type": "string"
      -          },
      -          "updatedAt": {
      -            "type": "string"
      -          },
      -          "visibility": {
      -            "enum": [
      -              "private",
      -              "shared",
      -              "public"
      -            ],
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "id",
      -          "ownerId",
      -          "folderId",
      -          "categoryId",
      -          "title",
      -          "content",
      -          "visibility",
      -          "createdAt",
      -          "updatedAt"
      -        ],
      -        "type": "object"
      -      }
      -    },
      -    "required": [
      -      "operation",
      -      "result"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "operation": {
      -        "const": "markdown",
      -        "type": "string"
      -      },
      -      "result": {
      -        "additionalProperties": {},
      -        "properties": {
      -          "filename": {
      -            "type": "string"
      -          },
      -          "markdown": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "markdown"
      -        ],
      -        "type": "object"
      -      }
      -    },
      -    "required": [
      -      "operation",
      -      "result"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "operation": {
      -        "const": "versions",
      -        "type": "string"
      -      },
      -      "result": {
      -        "items": {
      -          "additionalProperties": {},
      -          "properties": {
      -            "content": {
      -              "type": "string"
      -            },
      -            "contentJson": {},
      -            "createdAt": {
      -              "type": "string"
      -            },
      -            "createdBy": {
      -              "type": "string"
      -            },
      -            "description": {
      -              "anyOf": [
      -                {
      -                  "type": "string"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ]
      -            },
      -            "documentId": {
      -              "type": "string"
      -            },
      -            "id": {
      -              "type": "string"
      -            },
      -            "isSnapshot": {
      -              "type": "boolean"
      -            },
      -            "label": {
      -              "anyOf": [
      -                {
      -                  "type": "string"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ]
      -            },
      -            "restoredFrom": {
      -              "anyOf": [
      -                {
      -                  "type": "string"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ]
      -            }
      -          },
      -          "required": [
      -            "id",
      -            "documentId",
      -            "content",
      -            "createdBy",
      -            "createdAt"
      -          ],
      -          "type": "object"
      -        },
      -        "type": "array"
      -      }
      -    },
      -    "required": [
      -      "operation",
      -      "result"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "operation": {
      +        "const": "detail",
      +        "type": "string"
      +      },
      +      "result": {
      +        "additionalProperties": {},
      +        "properties": {
      +          "categoryId": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "content": {
      +            "type": "string"
      +          },
      +          "contentJson": {},
      +          "createdAt": {
      +            "type": "string"
      +          },
      +          "folderId": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "folderName": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "id": {
      +            "type": "string"
      +          },
      +          "metadata": {},
      +          "ownerId": {
      +            "type": "string"
      +          },
      +          "tags": {
      +            "items": {
      +              "additionalProperties": {},
      +              "properties": {
      +                "color": {
      +                  "type": [
      +                    "string",
      +                    "null"
      +                  ]
      +                },
      +                "createdAt": {
      +                  "type": "string"
      +                },
      +                "documentCount": {
      +                  "type": "number"
      +                },
      +                "id": {
      +                  "type": "string"
      +                },
      +                "name": {
      +                  "type": "string"
      +                }
      +              },
      +              "required": [
      +                "id",
      +                "name",
      +                "color"
      +              ],
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "title": {
      +            "type": "string"
      +          },
      +          "updatedAt": {
      +            "type": "string"
      +          },
      +          "visibility": {
      +            "enum": [
      +              "private",
      +              "shared",
      +              "public"
      +            ],
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "id",
      +          "ownerId",
      +          "folderId",
      +          "categoryId",
      +          "title",
      +          "content",
      +          "visibility",
      +          "createdAt",
      +          "updatedAt"
      +        ],
      +        "type": "object"
      +      }
      +    },
      +    "required": [
      +      "operation",
      +      "result"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "operation": {
      +        "const": "markdown",
      +        "type": "string"
      +      },
      +      "result": {
      +        "additionalProperties": {},
      +        "properties": {
      +          "filename": {
      +            "type": "string"
      +          },
      +          "markdown": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "markdown"
      +        ],
      +        "type": "object"
      +      }
      +    },
      +    "required": [
      +      "operation",
      +      "result"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "operation": {
      +        "const": "versions",
      +        "type": "string"
      +      },
      +      "result": {
      +        "items": {
      +          "additionalProperties": {},
      +          "properties": {
      +            "content": {
      +              "type": "string"
      +            },
      +            "contentJson": {},
      +            "createdAt": {
      +              "type": "string"
      +            },
      +            "createdBy": {
      +              "type": "string"
      +            },
      +            "description": {
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            },
      +            "documentId": {
      +              "type": "string"
      +            },
      +            "id": {
      +              "type": "string"
      +            },
      +            "isSnapshot": {
      +              "type": "boolean"
      +            },
      +            "label": {
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            },
      +            "restoredFrom": {
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            }
      +          },
      +          "required": [
      +            "id",
      +            "documentId",
      +            "content",
      +            "createdBy",
      +            "createdAt"
      +          ],
      +          "type": "object"
      +        },
      +        "type": "array"
      +      }
      +    },
      +    "required": [
      +      "operation",
      +      "result"
      +    ],
      +    "type": "object"
      +  }
      +]
  3. Changed3 schema fields changedv1.0.3
    • addedInput schema / additionalProperties
      Added value: +false
    • changedInput schema / oneOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "id": {
      -        "description": "UUID returned by the corresponding list or read operation.",
      -        "format": "uuid",
      -        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      -        "type": "string"
      -      },
      -      "view": {
      -        "const": "detail",
      -        "description": "Select the detail operation explicitly.",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "view",
      -      "id"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "id": {
      -        "description": "UUID returned by the corresponding list or read operation.",
      -        "format": "uuid",
      -        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      -        "type": "string"
      -      },
      -      "view": {
      -        "const": "markdown",
      -        "description": "Select the markdown operation explicitly.",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "view",
      -      "id"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "id": {
      -        "description": "UUID returned by the corresponding list or read operation.",
      -        "format": "uuid",
      -        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      -        "type": "string"
      -      },
      -      "onlySnapshots": {
      -        "description": "When true, return only named snapshots.",
      -        "type": "boolean"
      -      },
      -      "view": {
      -        "const": "versions",
      -        "description": "Select the versions operation explicitly.",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "view",
      -      "id"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "allOf": [
      +      {
      +        "not": {
      +          "anyOf": [
      +            {
      +              "required": [
      +                "onlySnapshots"
      +              ]
      +            }
      +          ]
      +        }
      +      }
      +    ],
      +    "properties": {
      +      "id": {
      +        "description": "UUID returned by the corresponding list or read operation.",
      +        "format": "uuid",
      +        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +        "type": "string"
      +      },
      +      "view": {
      +        "const": "detail",
      +        "description": "Select the detail operation explicitly.",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "view",
      +      "id"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "allOf": [
      +      {
      +        "not": {
      +          "anyOf": [
      +            {
      +              "required": [
      +                "onlySnapshots"
      +              ]
      +            }
      +          ]
      +        }
      +      }
      +    ],
      +    "properties": {
      +      "id": {
      +        "description": "UUID returned by the corresponding list or read operation.",
      +        "format": "uuid",
      +        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +        "type": "string"
      +      },
      +      "view": {
      +        "const": "markdown",
      +        "description": "Select the markdown operation explicitly.",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "view",
      +      "id"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "id": {
      +        "description": "UUID returned by the corresponding list or read operation.",
      +        "format": "uuid",
      +        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +        "type": "string"
      +      },
      +      "onlySnapshots": {
      +        "description": "When true, return only named snapshots.",
      +        "type": "boolean"
      +      },
      +      "view": {
      +        "const": "versions",
      +        "description": "Select the versions operation explicitly.",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "view",
      +      "id"
      +    ],
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties
      Added value: +{
      +  "id": {
      +    "anyOf": [
      +      {
      +        "description": "UUID returned by the corresponding list or read operation.",
      +        "format": "uuid",
      +        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +        "type": "string"
      +      },
      +      {
      +        "description": "UUID returned by the corresponding list or read operation.",
      +        "format": "uuid",
      +        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +        "type": "string"
      +      },
      +      {
      +        "description": "UUID returned by the corresponding list or read operation.",
      +        "format": "uuid",
      +        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +        "type": "string"
      +      }
      +    ]
      +  },
      +  "onlySnapshots": {
      +    "description": "When true, return only named snapshots.",
      +    "type": "boolean"
      +  },
      +  "view": {
      +    "anyOf": [
      +      {
      +        "const": "detail",
      +        "description": "Select the detail operation explicitly.",
      +        "type": "string"
      +      },
      +      {
      +        "const": "markdown",
      +        "description": "Select the markdown operation explicitly.",
      +        "type": "string"
      +      },
      +      {
      +        "const": "versions",
      +        "description": "Select the versions operation explicitly.",
      +        "type": "string"
      +      }
      +    ]
      +  }
      +}
  4. Addedv0.1.2

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, so "All views are read-only" merely restates structured data and earns no credit. The description does add a little behavioral content by characterizing what versions returns (saved revisions and snapshots), but says nothing about permissions/scope behavior, version ordering, or result volume.

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: the action first, the view decision second, the safety guarantee last. No filler, no repetition, and the most important disambiguation (which view) is front-loaded.

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 an output schema present, return value detail is not required, and the description covers the main discriminator (view) plus the read-only guarantee. It leaves the optional onlySnapshots flag and workspaceId scoping behavior to the schema, which is acceptable given 75% coverage but keeps it short of fully complete.

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

Parameters4/5

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

The schema's own view descriptions are tautological ("Select the detail operation explicitly"), so the description's mapping of detail/markdown/versions to actual outputs adds genuine meaning beyond the schema. workspaceId and onlySnapshots are left entirely to the schema's own text.

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?

"Read one document by UUID" is a specific verb+resource with a clear single-item scope, and the three view modes make the tool's shape explicit. It does not explicitly contrast with siblings such as find_documents (which is how you obtain the UUID) or get_workspace_item, so differentiation is implied rather than stated.

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 the key selection guidance an agent needs: use detail for content+metadata, markdown for portable export, versions for revisions/snapshots. That covers the internal choice well. It stops short of saying when to reach for this tool versus find_documents or get_document_index_status.

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