Skip to main content
Glama

100Hires - AI ATS & Recruitment Software

Create note

hires_create_note

Create a discussion note for a candidate, with optional visibility (all or private) and @mentions that email the mentioned users.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYesHTML allowed
includeNoEmbed: user (author), candidate. Pass candidate so the widget can link to the candidate profile
user_idNoAuthor; defaults to the authenticated user
visibilityNoall (default) or private
candidate_idYesCandidate id or alias
mention_user_idsNoMentioned users get an email

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changed
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • removedInput schema / additionalProperties
      Removed value: -false
    • changedInput schema / properties / body / description
      Previous value: -"Note content. Supports HTML."New value: +"HTML allowed"
    • changedInput schema / properties / candidate_id / description
      Previous value: -"Candidate ID (numeric) or alias"New value: +"Candidate id or alias"
    • changedInput schema / properties / include / description
      Previous value: -"Include related resources, e.g. 'user' for author details, 'candidate' for full candidate object with url_backoffice. Set to `candidate` so the widget can link the candidate name to their backoffice profile."New value: +"Embed: user (author), candidate. Pass candidate so the widget can link to the candidate profile"
    • changedInput schema / properties / mention_user_ids / description
      Previous value: -"Array of user IDs to mention. Mentioned users receive email notifications."New value: +"Mentioned users get an email"
    • changedInput schema / properties / user_id / description
      Previous value: -"Author user ID. If omitted, the authenticated user is used"New value: +"Author; defaults to the authenticated user"
    • changedInput schema / properties / visibility / description
      Previous value: -"Visibility: 'all' (default) or 'private'"New value: +"all (default) or private"
  2. Changed1 schema field changed
    • changedInput schema / properties / include / description
      Previous value: -"Include related resources, e.g. 'user' for author details, 'candidate' for full candidate object with profile_url. Set to `candidate` so the widget can link the candidate name to their backoffice profile."New value: +"Include related resources, e.g. 'user' for author details, 'candidate' for full candidate object with url_backoffice. Set to `candidate` so the widget can link the candidate name to their backoffice profile."
  3. Changed1 schema field changed
    • changedInput schema / properties / include / description
      Previous value: -"Include related resources, e.g. 'user' for author details"New value: +"Include related resources, e.g. 'user' for author details, 'candidate' for full candidate object with profile_url. Set to `candidate` so the widget can link the candidate name to their backoffice profile."
  4. First observed

TDQS

A4/5.0
Behavior4/5

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

The description discloses a key side effect: @mentions email the mentioned users, which goes beyond the raw annotations (readOnlyHint=false, destructiveHint=false). It also mentions visibility options. While it doesn't address auth requirements or reversibility, the annotations already indicate a write operation, and the description adds the email notification behavior, which is valuable.

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?

The description is a single, front-loaded sentence that states the primary action first, then the optional features. It contains no filler or redundant phrasing, and every clause contributes to understanding the tool's behavior.

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 create tool with 100% schema coverage, the description covers the essential purpose and side effects. It doesn't mention required parameters (candidate_id, body) explicitly, but those are in the schema. There's no output schema to explain, and the behavior is simple. It lacks details like whether the note appears in a candidate timeline, but that's implicit from the tool's purpose. Overall, it's adequate for an agent to call it correctly.

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 each parameter already has a description (e.g., body allows HTML, candidate_id accepts id or alias, visibility defaults to all). The tool description summarizes these features but adds no new meaning beyond the schema. It does not explain interactions between parameters or provide context beyond what's already documented.

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?

The description states a specific verb ('Create'), resource ('discussion note'), and target ('for a candidate'), and lists optional features (visibility, @mentions). It clearly distinguishes from sibling tools like hires_update_note and hires_delete_note by indicating this tool creates, not modifies or removes, a note.

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?

The description implies usage (add a note to a candidate) but provides no explicit guidance on when to choose this over alternatives like hires_update_note or hires_delete_note. It also doesn't mention any conditions or prerequisites, such as the candidate needing to exist or user permissions. The context is clear from the name, but the description itself offers no direct routing.

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.