Skip to main content
Glama

Update announcement

bb_update_announcement
Idempotent

Edit an announcement's title or body in Blackboard; requires instructor role, writes enabled, and explicit confirmation.

Instructions

Edit an announcement title or body. Requires BB_ALLOW_WRITES=1, confirm:true and an instructor role.

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": {
      "courseId": "<courseId>",
      "announcementId": "<announcementId>"
    },
    "name": "bb_update_announcement"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyNo
titleNo
confirmNo
courseIdYes
announcementIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true and destructiveHint=false, so the safety profile is known. The description adds real value beyond that: an environment-variable write gate, a mandatory confirm flag, and an instructor-role auth requirement — exactly the preconditions an agent needs. It does not say what happens to fields not supplied, which would have pushed this to a 5.

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 waste, and the action with its editable fields is front-loaded ahead of the gating requirements. Nothing could be removed without losing information.

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 write tool with no output schema and 0% schema coverage, the definition covers permissions and field scope but omits two required parameters and any partial-update or error behavior. It is adequate to attempt the call, not adequate to call it confidently.

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 0% across 5 parameters, so the description carries the full burden. It identifies title, body and confirm but leaves courseId and announcementId — both required — completely undefined, and does not state that omitted title/body are left unchanged.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb plus resource ('Edit an announcement') and narrows the editable surface to 'title or body', which cleanly separates it from bb_create_announcement and bb_delete_announcement implied by their names. It stops just short of explicitly naming those siblings as alternatives.

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 supplies activation prerequisites (BB_ALLOW_WRITES=1, confirm:true, instructor role), which tells the agent when the call is even legal. It never says when to prefer this over creating a new announcement or deleting one, and gives no explicit exclusions, so guidance is implied rather than complete.

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