Skip to main content
Glama

insert_doc_markdown

Convert markdown content into formatted Google Docs by inserting headings, bold/italic text, lists, and checkboxes with native Google Docs styling.

Instructions

Insert markdown content into a Google Doc with native formatting applied.

Supports # H1-### H3, **bold**, *italic*, - bullets, 1. numbered, and - [ ] checkbox (also - [x]). Converts markdown into Google Docs API batch requests so headings, lists, and text emphasis render as proper Docs styles rather than raw markdown text.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
user_google_emailYes
document_idYesID of the document.
markdownYesMarkdown content to insert.
indexNoDocument index at which to insert (default 1 — start of body). Ignored when end_of_segment=True.
tab_idNoOptional tab ID to target a specific tab.
segment_idNoOptional header/footer/footnote segment ID.
end_of_segmentNoIf True, append to the end of the targeted segment/body without needing to calculate an index. Most reliable for empty segments; for non-empty segments, use inspect_doc_structure first to find the exact insertion index.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It effectively describes key traits: it performs a write operation ('Insert'), specifies the output behavior ('native formatting applied'), and details the conversion process ('Converts markdown into Google Docs API batch requests'). It also hints at reliability considerations for 'end_of_segment' usage. However, it does not address potential errors, rate limits, or authentication requirements explicitly.

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?

The description is appropriately sized and front-loaded, starting with the core purpose and immediately listing supported markdown features. Every sentence adds value: the first states the action, the second enumerates syntax, and the third explains the conversion process. There is no redundant or verbose content, making it efficient and easy to parse.

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?

Given the tool's complexity (7 parameters, mutation operation) and no annotations, the description does a good job covering the core functionality and markdown support. With an output schema present, it need not explain return values. However, it could improve by addressing error cases, permissions, or integration with sibling tools like 'inspect_doc_structure', which is mentioned but not elaborated.

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 input schema has high description coverage (86%), covering most parameters well. The description adds value by explaining the 'markdown' parameter's supported syntax (e.g., '**bold**', '- bullets'), which is not detailed in the schema. It also clarifies the tool's purpose, indirectly informing parameter use. However, it does not provide additional context for parameters like 'user_google_email' or 'tab_id' beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the specific action ('Insert markdown content into a Google Doc') and resource ('Google Doc'), distinguishing it from siblings like 'insert_doc_elements' or 'modify_doc_text' by focusing on markdown-to-native formatting conversion. It explicitly mentions the transformation process: 'Converts markdown into Google Docs API batch requests so headings, lists, and text emphasis render as proper Docs styles rather than raw markdown text.'

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?

The description implies usage through examples of supported markdown syntax (e.g., '# H1', '**bold**'), suggesting it's for formatting-rich content insertion. However, it lacks explicit guidance on when to use this tool versus alternatives like 'insert_doc_elements' or 'batch_update_doc', and does not mention prerequisites or exclusions, such as document accessibility or user permissions.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/HuntsDesk/ve-gws'

If you have feedback or need assistance with the MCP directory API, please join our Discord server