Skip to main content
Glama
FreeScout MCP Server

FreeScout MCP Server

Add Note to Ticket

freescout_add_note

Adds an internal note to a FreeScout ticket using its ID, number, or URL, so agents can record private context or updates without sending a reply to the customer.

Instructions

Add an internal note to a FreeScout ticket

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": {
      "ticket": "<ticket>",
      "note": "<note>"
    },
    "name": "freescout_add_note"
  }
}

Input Schema

NameRequiredDescriptionDefault
noteYesThe note content to add
ticketYesTicket ID, ticket number, or FreeScout URL
userIdNoUser ID for the note (default: from env)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv3.0.1
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedOutput schema / (root)
      Previous value: -{
      -  "$schema": "http://json-schema.org/draft-07/schema#",
      -  "additionalProperties": false,
      -  "properties": {
      -    "message": {
      -      "type": "string"
      -    },
      -    "success": {
      -      "type": "boolean"
      -    },
      -    "ticketId": {
      -      "type": "string"
      -    }
      -  },
      -  "required": [
      -    "success",
      -    "message",
      -    "ticketId"
      -  ],
      -  "type": "object"
      -}New value: +null
  2. First observedv2.1.1

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false and destructiveHint=false, so the write-but-non-destructive profile is covered. The description adds only the meaningful 'internal' qualifier (not visible to the customer); it says nothing about notification behavior, permissions required, or whether an existing note is modified.

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?

A single front-loaded sentence with no filler, and the key qualifier 'internal' appears before the object. It is terse to the point of omitting useful context, but nothing is redundant.

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 three-parameter write tool with full schema coverage and annotations, the definition is minimally sufficient. It leaves gaps around permissions, side effects (e.g., notifications or audit entries), and what a successful call returns, though no output schema exists to cover the latter.

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%, including the flexible 'ticket' identifier (ID, number, or URL) and the defaulted userId, so the schema does the heavy lifting. The description adds no further parameter meaning, which is the correct baseline when coverage is complete.

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 uses a specific verb ('Add') plus resource ('internal note') and target ('a FreeScout ticket'), and the qualifier 'internal' distinguishes it from customer-facing output such as freescout_create_draft_reply. It does not explicitly name a sibling, but the operation is unmistakable.

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?

Usage is only implied: 'internal' signals this is for non-customer-facing annotation rather than replies, which is a useful cue. There is no explicit when-to-use/when-not or naming of an alternative tool for public communication.

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