Skip to main content
Glama

Get unread counts

get_unread_counts
Read-only

Retrieve counts of unread comments and private messages in a PlanVortex organization to see what needs attention, then list them with comment or conversation tools.

Instructions

How many comments and private messages are waiting, in one call. This is the 'what do I have today?' tool: start here, then use list_comments or list_conversations to see what they are.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
id_organizationNoThe PlanVortex organization id. Optional: resolved automatically when there is only one to choose from, or when the server was configured with a default one.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
unread_commentsYes
unread_messagesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.11.1
    • changedInput schema / properties / id_organization / description
      Previous value: -"The PlanVortex organization id. Optional: if this app reaches a single organization, or the server was configured with a default one, it is resolved automatically."New value: +"The PlanVortex organization id. Optional: resolved automatically when there is only one to choose from, or when the server was configured with a default one."
  2. Changed1 schema field changedv0.7.0
    • addedInput schema / additionalProperties
      Added value: +false
  3. First observedv0.1.0

TDQS

A4.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds only the mild behavioral fact that results come 'in one call' (an aggregate rather than a listing); it says nothing about freshness, scope of what counts as unread, or rate limits.

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?

Two tight sentences, front-loaded with what the tool returns and followed by the usage routing. No filler, no repetition of the title.

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

Completeness5/5

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

For a zero-required-parameter read tool with an output schema, the description covers purpose, positioning, and next steps. Return values are handled by the output schema, so nothing an agent needs to invoke it correctly is missing.

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 coverage is 100% and the single optional id_organization parameter is fully documented in the schema, including auto-resolution and default behavior. The description adds no parameter-level meaning beyond that, so the baseline of 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 specific quantity (how many) over two concrete resources (comments and private messages) and explicitly frames it as a single aggregate call. An agent can distinguish this from list_comments/list_conversations without opening either schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit sequencing ('start here') and names the alternatives to use afterward (list_comments, list_conversations) with the reason ('to see what they are'). This is exactly the routing an agent needs to pick this tool over the list tools.

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