Skip to main content
Glama

needfix_add

Records a bug, feature, or other finding with dedupe-aware manager-authority checks, returning a receipt with the new or existing ID and normalized kind/severity.

Instructions

Manager-authority add of a NeedFix (dedupe-aware).

kind must be one of: bug, feature, improvement, idea, technical_debt, optimization, benchmark_gap, documentation_drift, security_risk, investigation, roadmap_candidate, refactor, security, docs, other. Common synonyms are normalised server-side and reported as kind_normalized: gap->improvement, defect->bug, performance->optimization, design->refactor, dead_code->technical_debt, test_coverage->improvement. severity must be one of: critical, high, medium, low, info. status defaults to captured; its authoritative choices are published in the field hint. Store lifecycle and manager authority still govern it.

Replies with a receipt (aiworkhub.needfix_add_receipt.v1): id, dedupe_key, status, kind, severity, created_at, provenance.origin, deduped with existing_id when the dedupe key matched a live row (the existing row is returned, nothing new is written), kind_normalized. The row itself is one needfix_show away.

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": {
      "title": "<title>",
      "description": "<description>"
    },
    "name": "needfix_add"
  }
}

Input Schema

NameRequiredDescriptionDefault
kindNoAccepted kind values: benchmark_gap, bug, docs, documentation_drift, feature, idea, improvement, investigation, optimization, other, refactor, roadmap_candidate, security, security_risk, technical_debt. Case, surrounding space and known synonyms are normalized server-side.other
tagsNoOptional list of free-text tags.
scopeNoOptional free-text scope label. With title and description it forms the dedupe key, so the same text under another scope is a separate row.
titleYesShort title of the NeedFix; required, non-empty.
statusNoAccepted status values: accepted, archived, captured, deferred, duplicate, rejected, resolved, task_created, task_planned, triaged. Defaults to captured; store lifecycle and authority gates still apply.captured
evidenceNoOptional evidence object, at most 500000 bytes serialized; omit when there is none.
severityNoAccepted severity values: critical, high, info, low, medium.medium
caused_byNoOptional object naming the accepted outcome that introduced the defect: schema_id aiworkhub.accepted_outcome_identity.v1, repository_id, task_id, request_id and accepted_outcome_receipt. Verified against the canonical task store and write-once; omit if unknown.
provenanceNoOptional object describing where the finding came from; the server sets origin to manager_add when it is absent and marks the row verified.
descriptionYesFull description of the finding; required, non-empty, at most 200000 bytes.
scope_filesNoOptional list of repository file paths this NeedFix concerns.
evidence_refsNoOptional list of evidence reference strings.
scope_symbolsNoOptional list of code symbols this NeedFix concerns.
readiness_scoreNoReadiness score, an integer from 0 to 100; default 0.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed11 schema fields changedv0.12.67
    • addedInput schema / properties / caused_by / description
      Added value: +"Optional object naming the accepted outcome that introduced the defect: schema_id aiworkhub.accepted_outcome_identity.v1, repository_id, task_id, request_id and accepted_outcome_receipt. Verified against the canonical task store and write-once; omit if unknown."
    • addedInput schema / properties / description / description
      Added value: +"Full description of the finding; required, non-empty, at most 200000 bytes."
    • addedInput schema / properties / evidence / description
      Added value: +"Optional evidence object, at most 500000 bytes serialized; omit when there is none."
    • addedInput schema / properties / evidence_refs / description
      Added value: +"Optional list of evidence reference strings."
    • addedInput schema / properties / provenance / description
      Added value: +"Optional object describing where the finding came from; the server sets origin to manager_add when it is absent and marks the row verified."
    • addedInput schema / properties / readiness_score / description
      Added value: +"Readiness score, an integer from 0 to 100; default 0."
    • addedInput schema / properties / scope / description
      Added value: +"Optional free-text scope label. With title and description it forms the dedupe key, so the same text under another scope is a separate row."
    • addedInput schema / properties / scope_files / description
      Added value: +"Optional list of repository file paths this NeedFix concerns."
    • addedInput schema / properties / scope_symbols / description
      Added value: +"Optional list of code symbols this NeedFix concerns."
    • addedInput schema / properties / tags / description
      Added value: +"Optional list of free-text tags."
    • addedInput schema / properties / title / description
      Added value: +"Short title of the NeedFix; required, non-empty."
  2. 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 only declare write/not-destructive/closed-world. The description adds real behavior: server-side synonym normalisation with kind_normalized reporting, dedupe key matching against live rows, and receipt identity aiworkhub.needfix_add_receipt.v1 with its field list. It stops short of saying what authority is required or what happens on validation failure.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The purpose and dedupe semantics are front-loaded, which is good, but the middle section largely restates the schema's kind/severity/status enumerations and closes with the throwaway 'one needfix_show away'. Several sentences do not earn their place.

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

Completeness4/5

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

For a 14-parameter mutation with no output schema, the description usefully documents the return receipt (id, dedupe_key, status, kind, severity, created_at, provenance.origin, deduped/existing_id, kind_normalized). Optional structured params like caused_by and evidence are left entirely to the schema, but the core contract is covered.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 100% schema coverage the baseline is 3, but the description adds the synonym mapping (gap->improvement, defect->bug, performance->optimization, dead_code->technical_debt, test_coverage->improvement) that the schema does not enumerate. The status note ('authoritative choices are published in the field hint') is vague and mostly repeats the schema.

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?

The opening sentence gives a specific verb and resource ('Manager-authority add of a NeedFix') plus the distinguishing trait 'dedupe-aware'. It does not name the neighbouring capture/draft tools (aiworkhub_manager_needfix_draft, aiworkhub_dashboard_needfix_capture), so the agent must infer which writer to pick.

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 explains the dedupe short-circuit ('existing row is returned, nothing new is written') and the manager-authority gate, which is actionable context. However, it never states when to use this rather than needfix_draft or dashboard_needfix_capture, nor any exclusion or prerequisite.

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

Deploy Server

Other Tools