Skip to main content
Glama
dcianciulli

DefectDojo MCP Server

by dcianciulli

list_engagement_notes

Retrieve all notes associated with a specific DefectDojo engagement by ID to review annotations and track discussion history.

Instructions

List notes for an engagement.

Args: engagement_id: The engagement ID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
engagement_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.7/5.0
Behavior2/5

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

With no annotations, the description carries the full burden of behavioral disclosure. It says nothing about ordering, pagination, size limits, or permission requirements for reading an engagement's notes; it only restates the operation.

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

Conciseness3/5

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

The opening sentence is front-loaded and efficient, but the Args block is pure redundancy that adds no information beyond the schema. It is short, yet part of that shortness comes from omission rather than tight writing.

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?

An output schema exists, so return values need not be explained. For a simple one-parameter read tool the description is minimally viable, but it omits any note on result ordering or scope that would help an agent use it confidently.

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 description coverage is 0% for the single required parameter, and the description's 'Args: engagement_id: The engagement ID' merely repeats the parameter name without adding format, source, or lookup guidance. It therefore compensates for none of the coverage gap.

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 states a clear verb and resource: 'List notes for an engagement.' That is specific enough to identify the operation, but it offers no differentiation from siblings such as list_finding_notes, list_test_notes, or add_engagement_note, leaving the agent to infer the distinction from the name alone.

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 guidance on when to use this rather than the many other note-listing or note-adding tools. No preconditions, no statement of what it returns, and no mention of how it relates to add_engagement_note or list_note_types.

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