Skip to main content
Glama

Add a note

jobnimbus_create_note
Destructive

Add a note (activity entry) to a contact or job's activity feed. record_type_name defaults to Note; use another activity type from the account settings if needed. JobNimbus: POST /activities.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
noteYesThe note text.
actorNoOptional JobNimbus user email to act as. The record is created/edited with that user's permissions and shows them as the author. Needs an admin-level API key.
is_privateNoMark the note private.
primary_idYesjnid of the contact or job the note belongs to (sent as primary.id).
record_type_nameNoActivity type name. Defaults to Note.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior3/5

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

Annotations only carry title and destructiveHint=true; the description discloses the default activity type and the underlying endpoint (POST /activities), which is modest extra context. It does not say what happens on a bad primary_id, whether the note is immediately visible, or why the operation is flagged destructive, and the admin-key requirement for 'actor' lives only in the schema. No contradiction with annotations.

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?

Three short sentences, front-loaded with the action and target, then the default value, then the endpoint. The trailing 'JobNimbus: POST /activities.' is the weakest sentence but is compact and plausibly useful for traceability rather than padding.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple create tool with a fully documented 5-parameter schema, no output schema, and a safety annotation already present, the description covers the essentials an agent needs to invoke it. Only minor gaps remain (no return/confirmation info, no explicit prerequisite that the referenced contact or job must exist).

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%, so the schema already explains every parameter including the Defaults-to-Note behavior and the admin-key caveat for 'actor'. The description's mention of the record_type_name default essentially restates the schema, so the baseline 3 applies.

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?

States a precise verb and resource ('Add a note (activity entry) to a contact or job's activity feed'), immediately distinguishing it from jobnimbus_create_contact, create_job, create_task and from the read-side jobnimbus_list_activities. The parenthetical '(activity entry)' clarifies the underlying JobNimbus object so there is no ambiguity about what is created.

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?

Offers one piece of usage context: record_type_name defaults to Note and other activity types can be pulled 'from the account settings'. But it gives no when-to-use/when-not guidance, no prerequisites (e.g. that the target contact/job must already exist, or that actor requires an admin key), and never points to a sibling tool for related operations.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.