Skip to content

Improve kb_record_event tool definition (Glama C/2.9 -> A) #153

Description

@ajdelaguila

Summary

Glama rates kb_record_event at C, 2.9/5 — the only tool in the server scoring below A. Raising it lifts the whole Tool Definition Quality signal and, more importantly, stops agents from misusing the tool.

Score page: https://glama.ai/mcp/servers/knaisoma/data-olympus/score

Per-dimension breakdown (Glama)

Dimension Score Glama note
Behavior 2/5 Description implies a write but does not disclose the side effect, auth needs, or consequences beyond annotations.
Completeness 2/5 5 params (4 required) but the description never explains why one records events or the audit context.
Usage Guidelines 2/5 No "when to use vs alternatives" guidance.
Parameters 3/5 Baseline (schema coverage already 100%).
Purpose 4/5 Clear verb + resource.
Conciseness 4/5 Fine.

Source

src/data_olympus/server.py:1104 (kb_record_event), annotations STATEFUL_NONDESTRUCTIVE_TOOL. Current docstring:

Record a gate_bypass or gate_degraded enforcement event in the audit.

Actions (rewrite the docstring)

  • Behavior: state that it appends an entry to the audit log (durable side effect, non-destructive, requires write capability). Agents must know it mutates state before calling.
  • Usage Guidelines: say when to call it (an enforce hook bypassed or degraded the gate and the fallback must be recorded) and when NOT to — use kb_gate_check to check a gate, kb_consult to consult, kb_compliance/kb_audit to read events back.
  • Completeness: explain the audit/compliance feedback loop the event feeds; document the two event_type values (gate_bypass, gate_degraded) and the required params.
  • Keep it tight so Conciseness (4/5) does not regress.

Acceptance

  • Glama re-score of kb_record_event >= A (>= 4.0), with Behavior, Completeness, and Usage Guidelines each >= 4.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requestglamaGlama.ai registry score / discoverability

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions