Skip to main content
Glama

docs.documents.get

Retrieve a specified Google Docs document as JSON by ID, with options to include or omit comments and suggestions.

Instructions

Gets the latest version of the specified document [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchUpdate, create.

Input Schema

NameRequiredDescriptionDefault
queryNoExtra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe.
paramsNoParameter map merged into the request; typed parameters win.
dry_runNoReturn the request that would be sent, without sending it.
body_fileNoRead the request body from this file ('-' for stdin) instead of building one from the parameters.
documentIdYes[URL path segment] The ID of the document to retrieve.
commentsViewModeNo[query parameter] The comments view mode to apply to the document. This allows viewing the document with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE Values: `COMMENTS_VIEW_MODE_UNSPECIFIED` = The CommentsViewMode is unspecified. COMMENTS_VIEW_MODE_OMITTED is applied.; `COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS` = The CommentsViewMode applied to the returned document depends on the user's current access level. If the user only has view access, COMMENTS_VIEW_MODE_OMITTED is applied. Otherwise, COMMENTS_VIEW_MODE_INCLUDED is applied.; `COMMENTS_VIEW_MODE_OMITTED` = The returned document has comments omitted.; `COMMENTS_VIEW_MODE_INCLUDED` = The returned document has comments included. Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view comments. When set, suggestions_view_mode must also be set to SUGGESTIONS_INLINE. Returns a 400 bad request error otherwise..
includeTabsContentNo[query parameter] Whether to populate the `Document.tabs` field instead of the text content fields like `body` and `documentStyle` on `Document`. - When `true`: Document content
suggestionsViewModeNo[query parameter] The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified, Values: `DEFAULT_FOR_CURRENT_ACCESS` = The SuggestionsViewMode applied to the returned document depends on the user's current access level. If the user only has view access, PREVIEW_WITHOUT_SUGGESTIONS is applied. Otherwise, SUGGESTIONS_INLINE is applied. This is the default suggestions view mode.; `SUGGESTIONS_INLINE` = The returned document has suggestions inline. Suggested changes will be differentiated from base content within the document. Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes.; `PREVIEW_SUGGESTIONS_ACCEPTED` = The returned document is a preview with all suggested changes accepted. Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes.; `PREVIEW_WITHOUT_SUGGESTIONS` = The returned document is a preview with all suggested changes rejected if there are any suggestions in the document..

Output Schema

NameRequiredDescriptionDefault
bodyNo
tabsNo
listsNo
titleNo
footersNo
headersNo
commentsNo
footnotesNo
documentIdNo
revisionIdNo
namedRangesNo
namedStylesNo
suggestionsNo
documentStyleNo
inlineObjectsNo
commentsViewModeNo
positionedObjectsNo
suggestionsViewModeNo
suggestedNamedStylesChangesNo
suggestedDocumentStyleChangesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • changedInput schema / properties / commentsViewMode / description
      Previous value: -"The comments view mode to apply to the document. This allows viewing the document with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE"New value: +"[query parameter] The comments view mode to apply to the document. This allows viewing the document with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE Values: `COMMENTS_VIEW_MODE_UNSPECIFIED` = The CommentsViewMode is unspecified. COMMENTS_VIEW_MODE_OMITTED is applied.; `COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS` = The CommentsViewMode applied to the returned document depends on the user's current access level. If the user only has view access, COMMENTS_VIEW_MODE_OMITTED is applied. Otherwise, COMMENTS_VIEW_MODE_INCLUDED is applied.; `COMMENTS_VIEW_MODE_OMITTED` = The returned document has comments omitted.; `COMMENTS_VIEW_MODE_INCLUDED` = The returned document has comments included. Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view comments. When set, suggestions_view_mode must also be set to SUGGESTIONS_INLINE. Returns a 400 bad request error otherwise.."
    • changedInput schema / properties / documentId / description
      Previous value: -"The ID of the document to retrieve."New value: +"[URL path segment] The ID of the document to retrieve."
    • changedInput schema / properties / includeTabsContent / description
      Previous value: -"Whether to populate the `Document.tabs` field instead of the text content fields like `body` and `documentStyle` on `Document`. - When `true`: Document content "New value: +"[query parameter] Whether to populate the `Document.tabs` field instead of the text content fields like `body` and `documentStyle` on `Document`. - When `true`: Document content "
    • changedInput schema / properties / suggestionsViewMode / description
      Previous value: -"The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified,"New value: +"[query parameter] The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified, Values: `DEFAULT_FOR_CURRENT_ACCESS` = The SuggestionsViewMode applied to the returned document depends on the user's current access level. If the user only has view access, PREVIEW_WITHOUT_SUGGESTIONS is applied. Otherwise, SUGGESTIONS_INLINE is applied. This is the default suggestions view mode.; `SUGGESTIONS_INLINE` = The returned document has suggestions inline. Suggested changes will be differentiated from base content within the document. Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes.; `PREVIEW_SUGGESTIONS_ACCEPTED` = The returned document is a preview with all suggested changes accepted. Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes.; `PREVIEW_WITHOUT_SUGGESTIONS` = The returned document is a preview with all suggested changes rejected if there are any suggestions in the document.."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "body": {
      +      "properties": {
      +        "content": {
      +          "items": {
      +            "properties": {
      +              "endIndex": {
      +                "type": "integer"
      +              },
      +              "paragraph": {
      +                "properties": {
      +                  "bullet": {
      +                    "type": "object"
      +                  },
      +                  "elements": {
      +                    "items": {
      +                      "type": "object"
      +                    },
      +                    "type": "array"
      +                  },
      +                  "paragraphStyle": {
      +                    "type": "object"
      +                  },
      +                  "positionedObjectIds": {
      +                    "items": {
      +                      "type": "string"
      +                    },
      +                    "type": "array"
      +                  },
      +                  "suggestedBulletChanges": {
      +                    "type": "object"
      +                  },
      +                  "suggestedParagraphStyleChanges": {
      +                    "type": "object"
      +                  },
      +                  "suggestedPositionedObjectIds": {
      +                    "type": "object"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "sectionBreak": {
      +                "properties": {
      +                  "sectionStyle": {
      +                    "type": "object"
      +                  },
      +                  "suggestedDeletionIds": {
      +                    "items": {
      +                      "type": "string"
      +                    },
      +                    "type": "array"
      +                  },
      +                  "suggestedInsertionIds": {
      +                    "items": {
      +                      "type": "string"
      +                    },
      +                    "type": "array"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "startIndex": {
      +                "type": "integer"
      +              },
      +              "table": {
      +                "properties": {
      +                  "columns": {
      +                    "type": "integer"
      +                  },
      +                  "rows": {
      +                    "type": "integer"
      +                  },
      +                  "suggestedDeletionIds": {
      +                    "items": {
      +                      "type": "string"
      +                    },
      +                    "type": "array"
      +                  },
      +                  "suggestedInsertionIds": {
      +                    "items": {
      +                      "type": "string"
      +                    },
      +                    "type": "array"
      +                  },
      +                  "tableRows": {
      +                    "items": {
      +                      "type": "object"
      +                    },
      +                    "type": "array"
      +                  },
      +                  "tableStyle": {
      +                    "type": "object"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "tableOfContents": {
      +                "properties": {
      +                  "content": {
      +                    "items": {
      +                      "type": "object"
      +                    },
      +                    "type": "array"
      +                  },
      +                  "suggestedDeletionIds": {
      +                    "items": {
      +                      "type": "string"
      +                    },
      +                    "type": "array"
      +                  },
      +                  "suggestedInsertionIds": {
      +                    "items": {
      +                      "type": "string"
      +                    },
      +                    "type": "array"
      +                  }
      +                },
      +                "type": "object"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "comments": {
      +      "items": {
      +        "properties": {
      +          "anchorId": {
      +            "type": "string"
      +          },
      +          "commentId": {
      +            "type": "string"
      +          },
      +          "headPost": {
      +            "properties": {
      +              "assigneeEmail": {
      +                "type": "string"
      +              },
      +              "author": {
      +                "properties": {
      +                  "anonymous": {
      +                    "type": "boolean"
      +                  },
      +                  "displayName": {
      +                    "type": "string"
      +                  },
      +                  "me": {
      +                    "type": "boolean"
      +                  },
      +                  "user": {
      +                    "type": "string"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "commentAction": {
      +                "enum": [
      +                  "COMMENT_ACTION_TYPE_UNSPECIFIED",
      +                  "NO_COMMENT_ACTION_CHANGE",
      +                  "RESOLVE",
      +                  "REOPEN"
      +                ],
      +                "type": "string"
      +              },
      +              "content": {
      +                "type": "string"
      +              },
      +              "contentHtml": {
      +                "type": "string"
      +              },
      +              "createTime": {
      +                "type": "string"
      +              },
      +              "deleted": {
      +                "type": "boolean"
      +              },
      +              "fromCopiedDocument": {
      +                "type": "boolean"
      +              },
      +              "fromDocumentComparison": {
      +                "type": "boolean"
      +              },
      +              "fromImportedDocument": {
      +                "type": "boolean"
      +              },
      +              "postId": {
      +                "type": "string"
      +              },
      +              "suggestionAction": {
      +                "enum": [
      +                  "SUGGESTION_ACTION_TYPE_UNSPECIFIED",
      +                  "NO_SUGGESTION_ACTION_CHANGE",
      +                  "ACCEPT",
      +                  "REJECT"
      +                ],
      +                "type": "string"
      +              },
      +              "updateTime": {
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "plainTextQuote": {
      +            "type": "string"
      +          },
      +          "replies": {
      +            "items": {
      +              "properties": {
      +                "assigneeEmail": {
      +                  "type": "string"
      +                },
      +                "author": {
      +                  "properties": {
      +                    "anonymous": {
      +                      "type": "boolean"
      +                    },
      +                    "displayName": {
      +                      "type": "string"
      +                    },
      +                    "me": {
      +                      "type": "boolean"
      +                    },
      +                    "user": {
      +                      "type": "string"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "commentAction": {
      +                  "enum": [
      +                    "COMMENT_ACTION_TYPE_UNSPECIFIED",
      +                    "NO_COMMENT_ACTION_CHANGE",
      +                    "RESOLVE",
      +                    "REOPEN"
      +                  ],
      +                  "type": "string"
      +                },
      +                "content": {
      +                  "type": "string"
      +                },
      +                "contentHtml": {
      +                  "type": "string"
      +                },
      +                "createTime": {
      +                  "type": "string"
      +                },
      +                "deleted": {
      +                  "type": "boolean"
      +                },
      +                "fromCopiedDocument": {
      +                  "type": "boolean"
      +                },
      +                "fromDocumentComparison": {
      +                  "type": "boolean"
      +                },
      +                "fromImportedDocument": {
      +                  "type": "boolean"
      +                },
      +                "postId": {
      +                  "type": "string"
      +                },
      +                "suggestionAction": {
      +                  "enum": [
      +                    "SUGGESTION_ACTION_TYPE_UNSPECIFIED",
      +                    "NO_SUGGESTION_ACTION_CHANGE",
      +                    "ACCEPT",
      +                    "REJECT"
      +                  ],
      +                  "type": "string"
      +                },
      +                "updateTime": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "status": {
      +            "enum": [
      +              "STATUS_UNSPECIFIED",
      +              "OPEN",
      +              "RESOLVED"
      +            ],
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "commentsViewMode": {
      +      "enum": [
      +        "COMMENTS_VIEW_MODE_UNSPECIFIED",
      +        "COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS",
      +        "COMMENTS_VIEW_MODE_OMITTED",
      +        "COMMENTS_VIEW_MODE_INCLUDED"
      +      ],
      +      "type": "string"
      +    },
      +    "documentId": {
      +      "type": "string"
      +    },
      +    "documentStyle": {
      +      "properties": {
      +        "background": {
      +          "properties": {
      +            "color": {
      +              "properties": {
      +                "color": {
      +                  "type": "object"
      +                }
      +              },
      +              "type": "object"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "defaultFooterId": {
      +          "type": "string"
      +        },
      +        "defaultHeaderId": {
      +          "type": "string"
      +        },
      +        "documentFormat": {
      +          "properties": {
      +            "documentMode": {
      +              "enum": [
      +                "DOCUMENT_MODE_UNSPECIFIED",
      +                "PAGES",
      +                "PAGELESS"
      +              ],
      +              "type": "string"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "evenPageFooterId": {
      +          "type": "string"
      +        },
      +        "evenPageHeaderId": {
      +          "type": "string"
      +        },
      +        "firstPageFooterId": {
      +          "type": "string"
      +        },
      +        "firstPageHeaderId": {
      +          "type": "string"
      +        },
      +        "flipPageOrientation": {
      +          "type": "boolean"
      +        },
      +        "marginBottom": {
      +          "properties": {
      +            "magnitude": {
      +              "type": "number"
      +            },
      +            "unit": {
      +              "enum": [
      +                "UNIT_UNSPECIFIED",
      +                "PT"
      +              ],
      +              "type": "string"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "marginFooter": {
      +          "properties": {
      +            "magnitude": {
      +              "type": "number"
      +            },
      +            "unit": {
      +              "enum": [
      +                "UNIT_UNSPECIFIED",
      +                "PT"
      +              ],
      +              "type": "string"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "marginHeader": {
      +          "properties": {
      +            "magnitude": {
      +              "type": "number"
      +            },
      +            "unit": {
      +              "enum": [
      +                "UNIT_UNSPECIFIED",
      +                "PT"
      +              ],
      +              "type": "string"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "marginLeft": {
      +          "properties": {
      +            "magnitude": {
      +              "type": "number"
      +            },
      +            "unit": {
      +              "enum": [
      +                "UNIT_UNSPECIFIED",
      +                "PT"
      +              ],
      +              "type": "string"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "marginRight": {
      +          "properties": {
      +            "magnitude": {
      +              "type": "number"
      +            },
      +            "unit": {
      +              "enum": [
      +                "UNIT_UNSPECIFIED",
      +                "PT"
      +              ],
      +              "type": "string"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "marginTop": {
      +          "properties": {
      +            "magnitude": {
      +              "type": "number"
      +            },
      +            "unit": {
      +              "enum": [
      +                "UNIT_UNSPECIFIED",
      +                "PT"
      +              ],
      +              "type": "string"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "pageNumberStart": {
      +          "type": "integer"
      +        },
      +        "pageSize": {
      +          "properties": {
      +            "height": {
      +              "properties": {
      +                "magnitude": {
      +                  "type": "number"
      +                },
      +                "unit": {
      +                  "enum": [
      +                    "UNIT_UNSPECIFIED",
      +                    "PT"
      +                  ],
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "width": {
      +              "properties": {
      +                "magnitude": {
      +                  "type": "number"
      +                },
      +                "unit": {
      +                  "enum": [
      +                    "UNIT_UNSPECIFIED",
      +                    "PT"
      +                  ],
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "useCustomHeaderFooterMargins": {
      +          "type": "boolean"
      +        },
      +        "useEvenPageHeaderFooter": {
      +          "type": "boolean"
      +        },
      +        "useFirstPageHeaderFooter": {
      +          "type": "boolean"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "footers": {
      +      "type": "object"
      +    },
      +    "footnotes": {
      +      "type": "object"
      +    },
      +    "headers": {
      +      "type": "object"
      +    },
      +    "inlineObjects": {
      +      "type": "object"
      +    },
      +    "lists": {
      +      "type": "object"
      +    },
      +    "namedRanges": {
      +      "type": "object"
      +    },
      +    "namedStyles": {
      +      "properties": {
      +        "styles": {
      +          "items": {
      +            "properties": {
      +              "namedStyleType": {
      +                "enum": [
      +                  "NAMED_STYLE_TYPE_UNSPECIFIED",
      +                  "NORMAL_TEXT",
      +                  "TITLE",
      +                  "SUBTITLE",
      +                  "HEADING_1",
      +                  "HEADING_2",
      +                  "HEADING_3",
      +                  "HEADING_4",
      +                  "HEADING_5",
      +                  "HEADING_6"
      +                ],
      +                "type": "string"
      +              },
      +              "paragraphStyle": {
      +                "properties": {
      +                  "alignment": {
      +                    "enum": [
      +                      "ALIGNMENT_UNSPECIFIED",
      +                      "START",
      +                      "CENTER",
      +                      "END",
      +                      "JUSTIFIED"
      +                    ],
      +                    "type": "string"
      +                  },
      +                  "avoidWidowAndOrphan": {
      +                    "type": "boolean"
      +                  },
      +                  "borderBetween": {
      +                    "type": "object"
      +                  },
      +                  "borderBottom": {
      +                    "type": "object"
      +                  },
      +                  "borderLeft": {
      +                    "type": "object"
      +                  },
      +                  "borderRight": {
      +                    "type": "object"
      +                  },
      +                  "borderTop": {
      +                    "type": "object"
      +                  },
      +                  "direction": {
      +                    "enum": [
      +                      "CONTENT_DIRECTION_UNSPECIFIED",
      +                      "LEFT_TO_RIGHT",
      +                      "RIGHT_TO_LEFT"
      +                    ],
      +                    "type": "string"
      +                  },
      +                  "headingId": {
      +                    "type": "string"
      +                  },
      +                  "indentEnd": {
      +                    "type": "object"
      +                  },
      +                  "indentFirstLine": {
      +                    "type": "object"
      +                  },
      +                  "indentStart": {
      +                    "type": "object"
      +                  },
      +                  "keepLinesTogether": {
      +                    "type": "boolean"
      +                  },
      +                  "keepWithNext": {
      +                    "type": "boolean"
      +                  },
      +                  "lineSpacing": {
      +                    "type": "number"
      +                  },
      +                  "namedStyleType": {
      +                    "enum": [
      +                      "NAMED_STYLE_TYPE_UNSPECIFIED",
      +                      "NORMAL_TEXT",
      +                      "TITLE",
      +                      "SUBTITLE",
      +                      "HEADING_1",
      +                      "HEADING_2",
      +                      "HEADING_3",
      +                      "HEADING_4",
      +                      "HEADING_5",
      +                      "HEADING_6"
      +                    ],
      +                    "type": "string"
      +                  },
      +                  "pageBreakBefore": {
      +                    "type": "boolean"
      +                  },
      +                  "shading": {
      +                    "type": "object"
      +                  },
      +                  "spaceAbove": {
      +                    "type": "object"
      +                  },
      +                  "spaceBelow": {
      +                    "type": "object"
      +                  },
      +                  "spacingMode": {
      +                    "enum": [
      +                      "SPACING_MODE_UNSPECIFIED",
      +                      "NEVER_COLLAPSE",
      +                      "COLLAPSE_LISTS"
      +                    ],
      +                    "type": "string"
      +                  },
      +                  "tabStops": {
      +                    "items": {
      +                      "type": "object"
      +                    },
      +                    "type": "array"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "textStyle": {
      +                "properties": {
      +                  "backgroundColor": {
      +                    "type": "object"
      +                  },
      +                  "baselineOffset": {
      +                    "enum": [
      +                      "BASELINE_OFFSET_UNSPECIFIED",
      +                      "NONE",
      +                      "SUPERSCRIPT",
      +                      "SUBSCRIPT"
      +                    ],
      +                    "type": "string"
      +                  },
      +                  "bold": {
      +                    "type": "boolean"
      +                  },
      +                  "fontSize": {
      +                    "type": "object"
      +                  },
      +                  "foregroundColor": {
      +                    "type": "object"
      +                  },
      +                  "italic": {
      +                    "type": "boolean"
      +                  },
      +                  "link": {
      +                    "type": "object"
      +                  },
      +                  "smallCaps": {
      +                    "type": "boolean"
      +                  },
      +                  "strikethrough": {
      +                    "type": "boolean"
      +                  },
      +                  "underline": {
      +                    "type": "boolean"
      +                  },
      +                  "weightedFontFamily": {
      +                    "type": "object"
      +                  }
      +                },
      +                "type": "object"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "positionedObjects": {
      +      "type": "object"
      +    },
      +    "revisionId": {
      +      "type": "string"
      +    },
      +    "suggestedDocumentStyleChanges": {
      +      "type": "object"
      +    },
      +    "suggestedNamedStylesChanges": {
      +      "type": "object"
      +    },
      +    "suggestions": {
      +      "items": {
      +        "properties": {
      +          "headPost": {
      +            "properties": {
      +              "assigneeEmail": {
      +                "type": "string"
      +              },
      +              "author": {
      +                "properties": {
      +                  "anonymous": {
      +                    "type": "boolean"
      +                  },
      +                  "displayName": {
      +                    "type": "string"
      +                  },
      +                  "me": {
      +                    "type": "boolean"
      +                  },
      +                  "user": {
      +                    "type": "string"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "commentAction": {
      +                "enum": [
      +                  "COMMENT_ACTION_TYPE_UNSPECIFIED",
      +                  "NO_COMMENT_ACTION_CHANGE",
      +                  "RESOLVE",
      +                  "REOPEN"
      +                ],
      +                "type": "string"
      +              },
      +              "content": {
      +                "type": "string"
      +              },
      +              "contentHtml": {
      +                "type": "string"
      +              },
      +              "createTime": {
      +                "type": "string"
      +              },
      +              "deleted": {
      +                "type": "boolean"
      +              },
      +              "fromCopiedDocument": {
      +                "type": "boolean"
      +              },
      +              "fromDocumentComparison": {
      +                "type": "boolean"
      +              },
      +              "fromImportedDocument": {
      +                "type": "boolean"
      +              },
      +              "postId": {
      +                "type": "string"
      +              },
      +              "suggestionAction": {
      +                "enum": [
      +                  "SUGGESTION_ACTION_TYPE_UNSPECIFIED",
      +                  "NO_SUGGESTION_ACTION_CHANGE",
      +                  "ACCEPT",
      +                  "REJECT"
      +                ],
      +                "type": "string"
      +              },
      +              "updateTime": {
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "replies": {
      +            "items": {
      +              "properties": {
      +                "assigneeEmail": {
      +                  "type": "string"
      +                },
      +                "author": {
      +                  "properties": {
      +                    "anonymous": {
      +                      "type": "boolean"
      +                    },
      +                    "displayName": {
      +                      "type": "string"
      +                    },
      +                    "me": {
      +                      "type": "boolean"
      +                    },
      +                    "user": {
      +                      "type": "string"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "commentAction": {
      +                  "enum": [
      +                    "COMMENT_ACTION_TYPE_UNSPECIFIED",
      +                    "NO_COMMENT_ACTION_CHANGE",
      +                    "RESOLVE",
      +                    "REOPEN"
      +                  ],
      +                  "type": "string"
      +                },
      +                "content": {
      +                  "type": "string"
      +                },
      +                "contentHtml": {
      +                  "type": "string"
      +                },
      +                "createTime": {
      +                  "type": "string"
      +                },
      +                "deleted": {
      +                  "type": "boolean"
      +                },
      +                "fromCopiedDocument": {
      +                  "type": "boolean"
      +                },
      +                "fromDocumentComparison": {
      +                  "type": "boolean"
      +                },
      +                "fromImportedDocument": {
      +                  "type": "boolean"
      +                },
      +                "postId": {
      +                  "type": "string"
      +                },
      +                "suggestionAction": {
      +                  "enum": [
      +                    "SUGGESTION_ACTION_TYPE_UNSPECIFIED",
      +                    "NO_SUGGESTION_ACTION_CHANGE",
      +                    "ACCEPT",
      +                    "REJECT"
      +                  ],
      +                  "type": "string"
      +                },
      +                "updateTime": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "status": {
      +            "enum": [
      +              "STATUS_UNSPECIFIED",
      +              "OPEN",
      +              "ACCEPTED",
      +              "REJECTED"
      +            ],
      +            "type": "string"
      +          },
      +          "suggestionId": {
      +            "type": "string"
      +          },
      +          "summaryHtml": {
      +            "type": "string"
      +          },
      +          "summaryText": {
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "suggestionsViewMode": {
      +      "enum": [
      +        "DEFAULT_FOR_CURRENT_ACCESS",
      +        "SUGGESTIONS_INLINE",
      +        "PREVIEW_SUGGESTIONS_ACCEPTED",
      +        "PREVIEW_WITHOUT_SUGGESTIONS"
      +      ],
      +      "type": "string"
      +    },
      +    "tabs": {
      +      "items": {
      +        "properties": {
      +          "childTabs": {
      +            "items": {
      +              "properties": {
      +                "childTabs": {
      +                  "items": {
      +                    "properties": {
      +                      "childTabs": {
      +                        "items": {
      +                          "type": "object"
      +                        },
      +                        "type": "array"
      +                      },
      +                      "documentTab": {
      +                        "type": "object"
      +                      },
      +                      "tabProperties": {
      +                        "type": "object"
      +                      }
      +                    },
      +                    "type": "object"
      +                  },
      +                  "type": "array"
      +                },
      +                "documentTab": {
      +                  "properties": {
      +                    "body": {
      +                      "type": "object"
      +                    },
      +                    "commentAnchors": {
      +                      "type": "object"
      +                    },
      +                    "documentStyle": {
      +                      "type": "object"
      +                    },
      +                    "dropdownDefinitions": {
      +                      "type": "object"
      +                    },
      +                    "footers": {
      +                      "type": "object"
      +                    },
      +                    "footnotes": {
      +                      "type": "object"
      +                    },
      +                    "headers": {
      +                      "type": "object"
      +                    },
      +                    "inlineObjects": {
      +                      "type": "object"
      +                    },
      +                    "lists": {
      +                      "type": "object"
      +                    },
      +                    "namedRanges": {
      +                      "type": "object"
      +                    },
      +                    "namedStyles": {
      +                      "type": "object"
      +                    },
      +                    "positionedObjects": {
      +                      "type": "object"
      +                    },
      +                    "suggestedDocumentStyleChanges": {
      +                      "type": "object"
      +                    },
      +                    "suggestedNamedStylesChanges": {
      +                      "type": "object"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "tabProperties": {
      +                  "properties": {
      +                    "iconEmoji": {
      +                      "type": "string"
      +                    },
      +                    "index": {
      +                      "type": "integer"
      +                    },
      +                    "nestingLevel": {
      +                      "type": "integer"
      +                    },
      +                    "parentTabId": {
      +                      "type": "string"
      +                    },
      +                    "tabId": {
      +                      "type": "string"
      +                    },
      +                    "title": {
      +                      "type": "string"
      +                    }
      +                  },
      +                  "type": "object"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "documentTab": {
      +            "properties": {
      +              "body": {
      +                "properties": {
      +                  "content": {
      +                    "items": {
      +                      "type": "object"
      +                    },
      +                    "type": "array"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "commentAnchors": {
      +                "type": "object"
      +              },
      +              "documentStyle": {
      +                "properties": {
      +                  "background": {
      +                    "type": "object"
      +                  },
      +                  "defaultFooterId": {
      +                    "type": "string"
      +                  },
      +                  "defaultHeaderId": {
      +                    "type": "string"
      +                  },
      +                  "documentFormat": {
      +                    "type": "object"
      +                  },
      +                  "evenPageFooterId": {
      +                    "type": "string"
      +                  },
      +                  "evenPageHeaderId": {
      +                    "type": "string"
      +                  },
      +                  "firstPageFooterId": {
      +                    "type": "string"
      +                  },
      +                  "firstPageHeaderId": {
      +                    "type": "string"
      +                  },
      +                  "flipPageOrientation": {
      +                    "type": "boolean"
      +                  },
      +                  "marginBottom": {
      +                    "type": "object"
      +                  },
      +                  "marginFooter": {
      +                    "type": "object"
      +                  },
      +                  "marginHeader": {
      +                    "type": "object"
      +                  },
      +                  "marginLeft": {
      +                    "type": "object"
      +                  },
      +                  "marginRight": {
      +                    "type": "object"
      +                  },
      +                  "marginTop": {
      +                    "type": "object"
      +                  },
      +                  "pageNumberStart": {
      +                    "type": "integer"
      +                  },
      +                  "pageSize": {
      +                    "type": "object"
      +                  },
      +                  "useCustomHeaderFooterMargins": {
      +                    "type": "boolean"
      +                  },
      +                  "useEvenPageHeaderFooter": {
      +                    "type": "boolean"
      +                  },
      +                  "useFirstPageHeaderFooter": {
      +                    "type": "boolean"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "dropdownDefinitions": {
      +                "type": "object"
      +              },
      +              "footers": {
      +                "type": "object"
      +              },
      +              "footnotes": {
      +                "type": "object"
      +              },
      +              "headers": {
      +                "type": "object"
      +              },
      +              "inlineObjects": {
      +                "type": "object"
      +              },
      +              "lists": {
      +                "type": "object"
      +              },
      +              "namedRanges": {
      +                "type": "object"
      +              },
      +              "namedStyles": {
      +                "properties": {
      +                  "styles": {
      +                    "items": {
      +                      "type": "object"
      +                    },
      +                    "type": "array"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "positionedObjects": {
      +                "type": "object"
      +              },
      +              "suggestedDocumentStyleChanges": {
      +                "type": "object"
      +              },
      +              "suggestedNamedStylesChanges": {
      +                "type": "object"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "tabProperties": {
      +            "properties": {
      +              "iconEmoji": {
      +                "type": "string"
      +              },
      +              "index": {
      +                "type": "integer"
      +              },
      +              "nestingLevel": {
      +                "type": "integer"
      +              },
      +              "parentTabId": {
      +                "type": "string"
      +              },
      +              "tabId": {
      +                "type": "string"
      +              },
      +              "title": {
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "title": {
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  2. First observed

TDQS

B3.4/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It does disclose that this is an [HTTP GET] returning JSON, which establishes a safe read operation, but says nothing about permission requirements, quota behavior, or error conditions (the 403/400 cases for commentsViewMode live only in the schema).

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

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

The purpose is front-loaded and the sibling note is useful, but the middle sentence about building request bodies from typed parameters or reading from body_file is irrelevant boilerplate for a GET and adds confusion about whether a body is expected.

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 8 parameters at 100% schema coverage and an output schema documenting the returned Document, the description need not explain fields or return shape. It is nearly complete for a read operation, missing only an indication of required access to the document.

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%, so the baseline is 3. The description only adds generic template mechanics ('typed flags win over the params map', body_file) and provides no document-specific explanation of the meaningful flags like commentsViewMode, suggestionsViewMode, or includeTabsContent.

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?

States a specific verb and resource ('Gets the latest version of the specified document') and explicitly names the sibling operations over the same resource (batchUpdate, create), so an agent can distinguish it. The trailing boilerplate about request bodies dilutes but does not obscure the purpose.

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?

Naming batchUpdate and create as siblings implies that this tool is the read path, but the description never states when to prefer this over those or over other read paths such as drive.files.get or export. Usage is inferable from the operation names rather than explained.

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