Skip to main content
Glama
freeagent-mcp-server

freeagent-mcp-server

by samaxbytez

freeagent_delete_credit_note

Destructive

Deletes a specified credit note from FreeAgent by ID so it is removed from your accounting records.

Instructions

Delete a credit note from FreeAgent

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "credit_note_id": "<credit_note_id>"
    },
    "name": "freeagent_delete_credit_note"
  }
}

Input Schema

NameRequiredDescriptionDefault
credit_note_idYesThe ID of the credit note to delete

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv3.0.0
    • removedInput schema / additionalProperties
      Removed value: -false
  2. First observedv1.3.0

TDQS

B3.1/5.0
Behavior2/5

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

Annotations already declare destructiveHint=true and readOnlyHint=false, so the safety profile is covered by structured data. The description adds nothing beyond the word 'Delete' — no statement that the operation is permanent, no error conditions, no confirmation or permission requirements — so it contributes no behavioral context beyond the annotations.

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?

A single short sentence with the verb and resource front-loaded; there is no filler. Brevity is appropriate for a one-parameter tool, though it leaves the completeness gaps noted elsewhere.

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?

For a simple one-parameter destructive tool with full schema coverage and relevant annotations, the basics are in place. However, a destructive operation benefits from stating irreversibility and any side effects on linked records, which this description omits.

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 description coverage is 100% with a single well-documented credit_note_id parameter, so the schema carries the parameter explanation. The description adds no format, sourcing, or lookup detail (e.g., where to obtain the ID), so baseline 3 is appropriate.

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 specific verb (Delete) and resource (credit note) scoped to FreeAgent, which lets an agent distinguish it from freeagent_get_credit_note, freeagent_update_credit_note, and freeagent_list_credit_notes. It stops short of naming an alternative sibling to route against, but the action is unambiguous.

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 delete versus when to void/adjust a credit note, no prerequisites, and no note about what happens if the credit note has been applied or is referenced elsewhere. 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.

Deploy Server

Other Tools