Skip to main content
Glama

log_issue

Log a bug, regression, or unexpected behavior as a new issue before writing fix code, so the issue persists across interruptions and session boundaries.

Instructions

Open a new issue. Returns the issue ID.

MANDATORY: call this IMMEDIATELY when you encounter a bug, regression,
or unexpected behavior — BEFORE writing fix code. Logging up-front
means the issue survives interruptions and session boundaries.

Side effects: appends an `issue` event to .projectmem/events.jsonl,
creates an issue file in .projectmem/issues/, updates summary.md,
and marks this issue as the active one for subsequent
record_attempt calls.

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

Input Schema

NameRequiredDescriptionDefault
projectNoWhich project this call is about — a registered id, alias, or absolute path (e.g. 'ossdrop'). Omit it when the server was started for a single repo, or when an active project is set with `pjm project use`. Call list_projects to see the registered names.
summaryYesOne-line description of the bug or unexpected behavior. Becomes the issue title and is matched by search_events. Keep it under 140 characters.
locationNoOptional file path or component where the issue manifests (e.g., 'src/auth.py' or 'login/double-submit'). Used by precheck_file to surface this history later.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.3.5
    • changedInput schema / properties / summary / description
      Previous value: -"One-line description of the bug or unexpected behavior (~140 chars recommended). Becomes the issue title and is matched by search_events."New value: +"One-line description of the bug or unexpected behavior. Becomes the issue title and is matched by search_events. Keep it under 140 characters."
  2. Changed1 schema field changedv0.3.2
    • addedInput schema / properties / project
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Which project this call is about — a registered id, alias, or absolute path (e.g. 'ossdrop'). Omit it when the server was started for a single repo, or when an active project is set with `pjm project use`. Call list_projects to see the registered names.",
      +  "title": "Project"
      +}
  3. Changed2 schema fields changedv0.1.3
    • addedInput schema / properties / location / description
      Added value: +"Optional file path or component where the issue manifests (e.g., 'src/auth.py' or 'login/double-submit'). Used by precheck_file to surface this history later."
    • addedInput schema / properties / summary / description
      Added value: +"One-line description of the bug or unexpected behavior (~140 chars recommended). Becomes the issue title and is matched by search_events."
  4. First observedv0.1.1

TDQS

A4.7/5.0
Behavior5/5

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

With no annotations provided, the description carries the full burden and does so: it enumerates every side effect (appends to events.jsonl, creates a file under issues/, updates summary.md) and the stateful consequence of marking the issue active for record_attempt. That is exactly the write-scope information an agent needs before mutating persistent project memory.

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?

Front-loaded with the action and return value, then the mandatory trigger, then side effects. The capitalized MANDATORY block is justified because it encodes a hard behavioral requirement, and the one-line rationale for it earns its space by explaining why up-front logging matters.

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?

An output schema exists so return details need not be repeated, and the description still flags the returned issue ID. Combined with full schema coverage and complete side-effect disclosure, nothing an agent needs to invoke this correctly — scope, timing, persistence effects, downstream coupling — is missing.

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 the parameters are already fully documented, including the project resolution rules and the summary/location usage hints. The description adds no additional parameter-level meaning beyond what the schema states; it focuses on workflow and side effects instead, which is the correct baseline of 3.

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 ("Open a new issue") and the return value ("Returns the issue ID"), which separates it from read-side siblings like get_issue and from follow-up writers like record_attempt/record_fix. An agent knows immediately this is the creation entry point of the issue workflow.

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

Usage Guidelines5/5

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

Explicit trigger conditions are given ("when you encounter a bug, regression, or unexpected behavior") along with an ordering constraint ("BEFORE writing fix code") and the rationale for that ordering. It also names the downstream relationship to record_attempt, so the agent understands where this fits in the sequence rather than guessing.

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