Skip to main content
Glama
Lynsoft

fortimail-mcp-server

by Lynsoft

Download Log File

fortimail.logs.download
Read-onlyIdempotent

Download a FortiMail log file by its mkey to retrieve log contents as UTF-8 text for analysis or troubleshooting.

Instructions

Purpose: POST /v1/logs/download. Response bytes are interpreted as UTF-8 text (use compressed: false for plain text in MCP).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
log_fileYesLog file mkey from list
compressedNoIf true, request compressed payload from engine (when supported)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The description does add one genuinely useful behavioral fact beyond annotations: response bytes are interpreted as UTF-8 text, so compression affects decodability. It says nothing about auth requirements, payload size, or failure behavior, so it stays at the annotations-plus-one-detail level.

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?

Two short sentences with no filler, so nothing needs cutting. However, the front-loaded 'Purpose:' label leads into an API route instead of the actual purpose, and the brevity is partly under-specification rather than efficiency.

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

Completeness2/5

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

This is a download tool with no output schema, so the description must carry more of the return contract, yet it never says what is downloaded (log file content), in what format/size, or that `log_file` comes from `fortimail.logs.list`. For a binary/text-returning endpoint with two parameters, important invocation context is missing.

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?

Schema description coverage is 100%, so the baseline would be 3, but the description meaningfully extends `compressed`: the schema says only 'If true, request compressed payload from engine', while the description explains the MCP-side consequence (use `compressed: false` for plain text). `log_file` gets no extra semantics beyond the schema's 'mkey from list'.

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

Purpose2/5

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

The 'Purpose' line only restates the underlying REST route (`POST /v1/logs/download`), which is a tautology against the title 'Download Log File' rather than an explanation of what the tool retrieves. It gives no signal that distinguishes it from near-identical siblings such as `fortimail.reports.download` or `fortimail.queue.download`.

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?

There is no when-to-use guidance and no mention of the sibling download tools (reports.download, queue.download) that an agent must choose between. The only usage-flavored hint is the `compressed: false` recommendation, which is parameter-level rather than task-routing.

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

Deploy Server

Other Tools