Skip to main content
Glama

Remove Documentation Task

lyzr_semantic_model_remove_documentation_task
DestructiveIdempotent

Remove a scheduled documentation-save task for a table using the RAG config ID and table name.

Instructions

Remove a background documentation-save task for a table.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
table_nameYesTable name
rag_config_idYesRAG config id
Behavior3/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, so the description does not contradict them. It adds minor context by clarifying this removes a 'background' task, but does not disclose what happens to the task (e.g., whether it fails if already completed) or any other behavioral nuances. With annotations present, the bar is lower, but the description still provides limited additional transparency.

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?

A single, front-loaded sentence with no filler. It conveys the action, target, and scope efficiently, earning its place without redundancy.

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?

The tool is simple with two described parameters and clear annotations, so the brief description is mostly adequate. However, it lacks usage guidance and behavioral details that would help an agent understand when to invoke it and what to expect, making it minimally viable but not fully complete.

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% with both parameters (table_name and rag_config_id) already documented. The description adds no further semantics about how these parameters relate or how they affect the removal, so it does not go beyond the structured schema. Baseline 3 is appropriate for full schema coverage.

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 uses a specific verb ('Remove') and resource ('background documentation-save task for a table'), clearly distinguishing this from sibling tools like lyzr_semantic_model_remove_documentation and lyzr_semantic_model_save_documentation_task. It precisely states the action and scope.

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?

No guidance is given on when to use this tool versus alternatives. It does not mention that this cancels a scheduled task or contrast it with direct documentation removal methods, leaving the agent to infer usage solely from the tool name and sibling context.

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/nandanNM/lyzr-mcp'

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