Skip to main content
Glama

insert_doc_link

Add clickable hyperlinks to Google Docs by inserting linked text at specific document positions using document ID and target URL.

Instructions

Insert clickable linked text at a specified index in a document.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
user_google_emailYes
document_idYesID of the document.
textYesThe visible text for the link.
urlYesThe target URL (http/https/mailto supported).
indexNoDocument index at which to insert the link. Defaults to 1.
tab_idNoOptional tab ID to scope the insertion to.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior2/5

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

No annotations are provided, so the description carries full burden. It states the tool inserts a link but doesn't disclose behavioral traits: it doesn't mention if this is a mutating operation (implied by 'Insert'), what happens on failure (e.g., invalid index), whether it requires specific permissions, or if there are rate limits. For a tool that modifies documents, this lack of transparency is a significant gap.

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 a single, efficient sentence that front-loads the core action ('Insert clickable linked text') and key constraint ('at a specified index in a document'). There is no wasted verbiage, repetition, or unnecessary detail, making it easy for an agent to parse quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has an output schema (implied by 'Has output schema: true'), the description doesn't need to explain return values. However, for a mutation tool with no annotations and moderate complexity (6 parameters, 4 required), the description is minimal—it covers the basic purpose but lacks context on permissions, error handling, or integration with sibling tools. It's adequate but leaves clear gaps for the agent to navigate.

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 high (83%), with clear descriptions for most parameters (e.g., 'ID of the document', 'The visible text for the link'). The description adds no additional parameter semantics beyond what the schema provides—it doesn't explain relationships between parameters (e.g., how 'index' interacts with document content) or provide examples. Baseline 3 is appropriate given the schema does most of the work.

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?

The description clearly states the action ('Insert clickable linked text') and target ('at a specified index in a document'), which is specific and unambiguous. It distinguishes itself from siblings like 'insert_doc_elements' or 'insert_doc_image' by focusing specifically on hyperlinks. However, it doesn't explicitly mention what type of document (e.g., Google Docs) or differentiate from other link-related tools if any exist.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., document must exist, user must have edit permissions), compare to similar tools like 'insert_doc_elements' for general insertion, or specify use cases (e.g., adding references, creating navigation). The agent must infer usage solely from the tool name and parameters.

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