Skip to main content
Glama

Get Algorithm Help

get_algorithm_help
Read-only

Retrieve detailed help for any QGIS processing algorithm, including parameter names, types, optional flags, defaults, outputs, and description.

Instructions

Get detailed help for a processing algorithm: parameters (name, type, optional, default), outputs, and description.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
algorithm_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior3/5

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

Annotations already declare readOnlyHint=true. The description adds that the tool returns parameter details, outputs, and description, which is consistent and does not contradict annotations. It provides minimal additional behavioral context beyond the annotation.

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

Conciseness4/5

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

The description is one concise sentence that is front-loaded with the main verb and resource. It is efficient but could be slightly improved with structured details (e.g., bullet points) for readability.

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 has a single parameter and an output schema (not shown), so the description does not need to explain return values. However, it omits guidance on obtaining the algorithm_id (e.g., from sibling tools) and does not mention error conditions. Adequate for a simple read-only tool but not fully complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0%, so the description should add meaning to the algorithm_id parameter. It does not explain what algorithm_id is, how to obtain valid values (e.g., from list_processing_algorithms), or its format. This leaves the agent guessing.

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 tool retrieves detailed help for a processing algorithm, specifying the details included (parameters, outputs, description). It distinguishes itself from siblings like list_processing_algorithms (lists algorithms) and execute_processing (runs them).

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 for obtaining help on a specific algorithm but does not explicitly state when to use vs alternatives like list_processing_algorithms or execute_processing. No exclusion criteria or prerequisites are mentioned.

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/lefcgis/qgis-mcp'

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