Skip to main content
Glama
dcianciulli

DefectDojo MCP Server

by dcianciulli

list_test_notes

Retrieve notes attached to a DefectDojo test by supplying the test ID. Review test comments, updates, and related details.

Instructions

List notes for a test.

Args: test_id: The test ID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
test_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?

No annotations are provided, so the description carries the full disclosure burden. It says nothing about pagination, ordering, whether an empty list is returned for a test with no notes, or what happens with an invalid test_id, all of which matter for a read tool with no annotation coverage.

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 one-line purpose is front-loaded and free of padding, but the 'Args:' block consumes half the text to deliver zero information beyond the parameter name, so the structure is efficient yet hollow.

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 described, and the tool is a simple single-parameter list. Still, with no annotations and no statement of scope or pagination, the definition is only minimally adequate for invoking the tool correctly.

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% and the only parameter is explained as 'test_id: The test ID', which merely restates the parameter name. It adds no meaning such as where to obtain the ID or whether it must belong to an accessible test.

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?

States a specific verb ('List') and resource ('notes for a test'), which is clear enough for an agent to pick it over list_finding_notes or list_engagement_notes. However, it offers no explicit differentiation from those sibling note-listing tools beyond the word 'test'.

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 when-to-use context, no prerequisites, and no mention of the related add_test_note or list_note_types siblings. The agent must infer usage entirely from the name.

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