Gws Docs

{
  "schema_version": "2.0",
  "meta": {
    "generated_at": "2026-03-25T08:23:19.869Z",
    "slug": "googleworkspace-gws-docs",
    "source_url": "https://github.com/googleworkspace/cli/tree/main/skills/gws-docs/",
    "source_ref": "main",
    "model": "claude",
    "analysis_version": "3.0.0",
    "source_type": "community",
    "content_hash": "ec54a18914a998d122fe63e3fd40ae06770744769e7047473ea1df683db9f2ec",
    "tree_hash": "38e9b735cf716388a8794f06b9b844ba58e4573cf78c5d49290069e26064cf4a"
  },
  "skill": {
    "name": "gws-docs",
    "description": "Access Google Docs API to read, create, and update documents through the Google Workspace CLI.",
    "summary": "Read, create, and update Google Docs through the gws CLI tool.",
    "icon": "📄",
    "version": "1.0.0",
    "author": "googleworkspace",
    "license": "MIT",
    "tags": [
      "google-workspace",
      "google-docs",
      "documentation",
      "productivity"
    ],
    "supported_tools": [
      "claude",
      "codex",
      "claude-code"
    ],
    "risk_factors": []
  },
  "security_audit": {
    "risk_level": "safe",
    "is_blocked": false,
    "safe_to_publish": true,
    "summary": "Static analysis flagged 17 potential issues, all evaluated as false positives. The skill is a documentation wrapper for the Google Workspace CLI (gws) tool that provides read and write access to Google Docs API. All backtick patterns are markdown inline code syntax, path references are documentation links, and no cryptographic algorithms or network calls are present in the skill file.",
    "critical_findings": [],
    "high_findings": [],
    "medium_findings": [
      {
        "title": "Markdown Backtick Syntax Misidentified as Command Execution",
        "description": "Static analyzer detected backtick patterns at multiple lines (16, 18, 20, 26, 32, 33, 34, 40, 46, 48), flagging as 'Ruby/shell backtick execution'. These are markdown inline code formatting delimiters used for documenting command syntax and file paths, not command execution.",
        "locations": [
          {
            "file": "SKILL.md",
            "line_start": 16,
            "line_end": 16
          },
          {
            "file": "SKILL.md",
            "line_start": 18,
            "line_end": 20
          },
          {
            "file": "SKILL.md",
            "line_start": 20,
            "line_end": 26
          },
          {
            "file": "SKILL.md",
            "line_start": 26,
            "line_end": 32
          },
          {
            "file": "SKILL.md",
            "line_start": 32,
            "line_end": 33
          },
          {
            "file": "SKILL.md",
            "line_start": 33,
            "line_end": 34
          },
          {
            "file": "SKILL.md",
            "line_start": 34,
            "line_end": 40
          },
          {
            "file": "SKILL.md",
            "line_start": 40,
            "line_end": 46
          },
          {
            "file": "SKILL.md",
            "line_start": 46,
            "line_end": 48
          }
        ],
        "verdict": "false_positive",
        "confidence": 0.95,
        "confidence_reasoning": "All backtick usage is within markdown documentation context, formatting inline code examples and file paths. No shell or Ruby command execution syntax is present."
      },
      {
        "title": "Markdown Text Misidentified as Python HTTP Libraries",
        "description": "Static analyzer flagged line 32 as containing Python HTTP libraries. Line 32 contains API documentation text describing the batchUpdate method, not Python code.",
        "locations": [
          {
            "file": "SKILL.md",
            "line_start": 32,
            "line_end": 32
          }
        ],
        "verdict": "false_positive",
        "confidence": 0.92,
        "confidence_reasoning": "Line 32 is documentation text: '- `batchUpdate` — Applies one or more updates to the document.' No HTTP library calls exist."
      }
    ],
    "low_findings": [
      {
        "title": "Relative Path References Misidentified as Path Traversal",
        "description": "Static analyzer flagged paths '..//gws-shared/SKILL.md' and '../gws-docs-write/SKILL.md' as path traversal sequences. These are standard markdown relative links between documentation files.",
        "locations": [
          {
            "file": "SKILL.md",
            "line_start": 16,
            "line_end": 16
          },
          {
            "file": "SKILL.md",
            "line_start": 26,
            "line_end": 26
          }
        ],
        "verdict": "false_positive",
        "confidence": 0.9,
        "confidence_reasoning": "These are documented relative links between skill markdown files for navigation purposes, not filesystem operations."
      },
      {
        "title": "YAML and Markdown Syntax Misidentified as Cryptographic Algorithms",
        "description": "Static analyzer flagged lines 3 and 24 as containing weak cryptographic algorithms. Line 3 contains YAML frontmatter description field; line 24 is a markdown table header. No cryptographic code exists.",
        "locations": [
          {
            "file": "SKILL.md",
            "line_start": 3,
            "line_end": 3
          },
          {
            "file": "SKILL.md",
            "line_start": 24,
            "line_end": 24
          }
        ],
        "verdict": "false_positive",
        "confidence": 0.95,
        "confidence_reasoning": "Content at flagged lines is YAML metadata and markdown table syntax. No cryptographic algorithms, encryption, or hashing code is present."
      }
    ],
    "dangerous_patterns": [],
    "files_scanned": 1,
    "total_lines": 50,
    "audit_model": "claude",
    "audited_at": "2026-03-25T08:23:19.869Z",
    "risk_factors": [],
    "risk_factor_evidence": []
  },
  "content": {
    "user_title": "Access Google Docs from Claude Code",
    "value_statement": "Managing Google Docs manually is time-consuming and error-prone. This skill enables Claude Code to read, create, and update Google Docs documents through the official Google Workspace CLI.",
    "seo_keywords": [
      "Claude Code Google Docs integration",
      "Google Docs CLI automation",
      "Google Workspace documentation tool",
      "gws docs command",
      "Claude Codex Google Docs skill",
      "automate Google Docs with AI",
      "Google Docs API wrapper",
      "document automation skill"
    ],
    "actual_capabilities": [
      "Read document content and metadata using the Google Docs API get method",
      "Create new blank documents with specified titles using the create method",
      "Apply batch updates to documents including text insertions, deletions, and formatting changes",
      "Discover available resources and methods using gws schema command",
      "Append text to documents using the gws-docs-write companion skill"
    ],
    "limitations": [
      "Requires the gws CLI tool to be installed and authenticated with Google Workspace",
      "Cannot directly manipulate complex formatting without using batchUpdate parameters correctly",
      "Limited to operations available through the Google Docs REST API v1"
    ],
    "use_cases": [
      {
        "title": "Auto-generate meeting notes",
        "description": "Claude Code reads project requirements and meeting transcripts, then creates a formatted Google Doc with agenda items, decisions made, and action items assigned.",
        "target_user": "Project managers and team leads"
      },
      {
        "title": "Sync documentation across platforms",
        "description": "Claude Code reads existing Google Docs to understand current documentation state, then updates or creates new docs to sync changes from codebase documentation.",
        "target_user": "Technical writers and documentation teams"
      },
      {
        "title": "Generate status reports",
        "description": "Claude Code aggregates data from various sources, compiles findings into a structured report, and creates or updates a designated Google Doc for team visibility.",
        "target_user": "Analysts and team coordinators"
      }
    ],
    "prompt_templates": [
      {
        "title": "Read a Google Doc",
        "prompt": "Use the gws-docs skill to get the content of the document at [DOCUMENT_ID]. Show me the full text content.",
        "scenario": "When user provides a Google Docs document ID and wants to read its contents"
      },
      {
        "title": "Create a new document",
        "prompt": "Create a new Google Doc titled [TITLE] with the following content: [CONTENT]. The document should be organized with clear sections.",
        "scenario": "When user wants to create a new Google Doc with specific content"
      },
      {
        "title": "Update existing document",
        "prompt": "Apply batch updates to document [DOCUMENT_ID] to add a new section titled [SECTION_TITLE] with the following paragraphs: [CONTENT]. Use the gws schema docs.documents.batchUpdate command to prepare the update.",
        "scenario": "When user wants to append or modify content in an existing document"
      },
      {
        "title": "Generate report from data",
        "prompt": "Analyze the data provided below and create a comprehensive report in Google Docs. First, inspect the available gws docs methods using gws schema docs --help. Then create a new document titled [REPORT_TITLE] with: an executive summary, key findings section, and recommendations section based on [DATA_OR_CONTEXT].",
        "scenario": "When user wants AI assistance to generate structured reports from raw data"
      }
    ],
    "output_examples": [
      {
        "input": "Create a new document titled 'Q1 Project Status' with project status information",
        "output": "Created new Google Doc with ID: 1abc123xyz Successfully created document with sections: Executive Summary, Current Progress, Blockers, Next Steps, and Action Items."
      },
      {
        "input": "Get the contents of document 1Bxf3KFGabc123XYZ",
        "output": "Retrieved document content:\n# Project Roadmap\n\n## Objectives\n- Complete API integration\n- Deploy staging environment\n- User acceptance testing\n\n## Timeline\nQ1: Core features\nQ2: Beta release"
      }
    ],
    "best_practices": [
      "Always inspect available methods with `gws docs --help` before making API calls to ensure correct syntax",
      "Use `gws schema docs.<resource>.<method>` to understand required parameters and types for each operation",
      "Store document IDs in variables for repeated access rather than typing them repeatedly in commands"
    ],
    "anti_patterns": [
      "Do not attempt to read or write documents without first verifying authentication with `gws auth status`",
      "Avoid making large batch updates without testing smaller changes first to avoid unintended document modifications",
      "Do not share or log document IDs from sensitive documents in outputs that may be exposed"
    ],
    "faq": [
      {
        "question": "What authentication is required for gws-docs?",
        "answer": "The gws CLI requires Google Workspace authentication. Run `gws auth login` to set up credentials before using the docs skill."
      },
      {
        "question": "Can I format documents with rich text?",
        "answer": "Yes, use the batchUpdate method with text formatting requests. Run `gws schema docs.documents.batchUpdate` to see available formatting options."
      },
      {
        "question": "How do I find a document ID?",
        "answer": "Document IDs are in the URL when viewing a Google Doc: docs.google.com/document/d/[DOCUMENT_ID]/edit"
      },
      {
        "question": "What is the difference between get and batchUpdate?",
        "answer": "get retrieves document content and metadata. batchUpdate applies changes like text insertions, deletions, or formatting modifications."
      },
      {
        "question": "Can I append content without replacing existing text?",
        "answer": "Yes, use batchUpdate with an insertText request at the end of the document. The gws-docs-write skill provides a simpler append interface."
      },
      {
        "question": "Does this skill work with Google Docs on personal accounts?",
        "answer": "This skill uses the Google Workspace CLI which supports both Google Workspace accounts and personal Google accounts with proper authentication."
      }
    ]
  },
  "file_structure": [
    {
      "name": "SKILL.md",
      "type": "file",
      "path": "SKILL.md",
      "lines": 50
    }
  ]
}