Skip to main content
Glama

publish_summary

Publish a work summary event for backward compatibility; current equivalent is publish_event with event_type='summary'.

Instructions

Publish a work summary event (convenience wrapper for publish_event with type=summary). Kept for backward compatibility; publish_event with event_type='summary' is the current equivalent.

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": {
      "project_id": "<project_id>",
      "summary": "<summary>"
    },
    "name": "publish_summary"
  }
}

Input Schema

NameRequiredDescriptionDefault
metricsNoMetrics (lines changed, tests passed, etc.).
summaryYesSummary of work done.
task_idNoRelated task ID.
blockersNoCurrent blockers.
next_stepsNoSuggested next steps.
project_idYesProject ID.
key_decisionsNoKey decisions made.
artifacts_createdNoArtifacts created.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, idempotentHint=false, destructiveHint=false, so the write/non-destructive profile is covered. The description adds the useful fact that behavior is inherited from publish_event, but says nothing about what publishing actually does — who consumes the event, whether it is appended or overwritten, or any rate/ordering semantics.

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 sentences, zero padding, with the core purpose stated first and the deprecation/alternative note second. Nothing repeats the name or title.

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 thin wrapper this is close to sufficient, but with 8 parameters, a nested free-form metrics object with no defined sub-properties, and no output schema, the agent gets no guidance on return behavior or what a 'work summary event' surfaces downstream. Adequate but noticeably thin for the schema surface.

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 all 8 parameters including summary, metrics, blockers, and next_steps are documented in the schema itself. The description adds no field-level meaning beyond restating the wrapper mapping; baseline 3 is appropriate.

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 verb and resource ('Publish a work summary event') and immediately defines its identity as a convenience wrapper for publish_event with type=summary. That framing distinguishes it from the sibling publish_event without requiring the agent to open 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 Guidelines4/5

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

Names the alternative explicitly ('publish_event with event_type=summary is the current equivalent') and signals via 'kept for backward compatibility' that this is the legacy path. It stops short of an explicit directive ('prefer publish_event for new work'), so the preference must be inferred.

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