Skip to main content
Glama

session_announce

Register session presence with an optional territory and send heartbeats so live peers are returned for splitting work and avoiding collisions.

Instructions

Announce this session on the session bus: registers presence with an optional territory (folder or theme this session will work on) and doubles as heartbeat. Call at session start and periodically during long work. Sessions without a heartbeat for 10 minutes are swept and their locks released. Returns the list of live peer sessions for the project so parallel sessions can split territory instead of colliding.

Input Schema

NameRequiredDescriptionDefault
territoryNoFolder or theme this session is claiming informally, e.g. 'scripts/lib' or 'docs sweep'.
session_idNoLeave out: the bus always acts as this server's own session, and any other id is refused.
project_pathNoAbsolute path to the project root. The first memory call or project-scoped bus call fixes this session's project (the working directory when omitted); a different project afterwards is refused.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.1.23
    • changedInput schema / properties / project_path / description
      Previous value: -"Absolute path to the project root. Defaults to current working directory."New value: +"Absolute path to the project root. The first memory call or project-scoped bus call fixes this session's project (the working directory when omitted); a different project afterwards is refused."
    • changedInput schema / properties / session_id / description
      Previous value: -"Stable identifier for this session. Defaults to the id opened by get_state, falling back to a process-scoped id."New value: +"Leave out: the bus always acts as this server's own session, and any other id is refused."
  2. Addedv1.1.17
  3. Removedv1.1.15
  4. Addedv1.1.14

TDQS

A4.5/5.0
Behavior5/5

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

With no annotations, the description carries the full burden and delivers: it discloses the 10-minute staleness sweep, that locks are released for swept sessions, and that the call returns live peer sessions. That is meaningful side-effect and lifecycle context an agent cannot infer from the schema.

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?

Four tight sentences, purpose front-loaded, then cadence, then the consequence of missing heartbeats, then the return value. No filler or repetition.

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?

No output schema, but the description explains what comes back (live peer sessions) and why it matters; combined with full schema coverage and no annotations, an agent has everything needed to call it correctly and interpret results.

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 each parameter already has a rich description (including the 'leave out' guidance for session_id and project_path fixing rules). The description only re-characterizes territory as an optional folder or theme, adding little beyond the schema, so 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 concrete verb and resource ('Announce this session on the session bus: registers presence...') and clarifies scope: presence registration plus heartbeat, distinct from session_peers/session_send. The final clause on returning live peers further separates it from pure mutators like claim_path.

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

Usage Guidelines4/5

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

Explicit timing guidance: 'Call at session start and periodically during long work,' plus the rationale 'so parallel sessions can split territory instead of colliding.' It does not explicitly name an alternative for just reading peers (session_peers exists), but the usage conditions are clear.

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