Skip to main content
Glama
snyk

Snyk API & Web MCP Server

Official
by snyk

probely_create_scanreport

Generate a scan report in PDF or HTML format, with options for executive, OWASP, PCI, HIPAA, or ISO27001 types. Returns report ID and metadata.

Instructions

Create a report for a scan. Returns report metadata including the report ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
scanIdYesThe scan ID to generate the report for
report_typeNoType of report - "default", "executive", "owasp", "pci", "hipaa", "iso27001"default
formatNoFile format - "pdf" or "html"pdf

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

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 only states the action and return value, but fails to disclose behavioral traits like whether the scan must be completed, whether the tool is idempotent, or any side effects (e.g., overwriting existing reports). This is a significant gap for a create operation.

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?

Two sentences, no redundancy, front-loaded with the core purpose. Every word contributes value.

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 that an output schema exists (context signal), the description need not detail return values, but it does mention 'report metadata including report ID'. However, it omits prerequisites like scan state (e.g., completed scan) and does not explain the meaning of report_type or format parameters beyond what the schema provides. For a simple tool, it's adequate but not 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 coverage is 100%, and the description adds no additional meaning beyond the input schema. The description's mention of 'report metadata including the report ID' is generic and does not elaborate on parameters. Baseline 3 is appropriate.

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 verb 'Create', the resource 'report for a scan', and explicitly mentions returning metadata including the report ID. It distinguishes from siblings like probely_downloadreport and probely_getreport by focusing on creation rather than retrieval.

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 generating a new report but provides no explicit guidance on when to use this tool versus alternatives (e.g., probely_getreport to retrieve existing reports, probely_downloadreport to download). No when-not or prerequisite conditions are stated.

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/snyk/saw-mcp'

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