Skip to content

lcm_grep docs describe an incorrect response shape #849

Description

@bcdonadio

Observed behavior: docs/agent-tools.md:77 describes lcm_grep as returning an array of matches with a session ID. Successful runtime grep instead returns GrepResult containing messages, summaries, and totalMatches; individual hits expose conversationId, not sessionId.

Expected behavior: End-user documentation describes the actual response envelope and hit identity fields. Also distinguish the existing missing-project response shape where necessary.

Root cause: The documentation return description drifted from src/retrieval.ts and store search-result types.

How to reproduce: Read the lcm_grep Returns paragraph and compare the GrepResult interface in src/retrieval.ts:153-157 and MessageSearchResult/SummarySearchResult. Static inspection is sufficient; no daemon or production data access is needed.

Environment:

  • Agent: Codex gpt-6-astra owner with Grok 4.6 reviewer
  • Connector: MCP
  • OS: Fedora Linux
  • Baseline: 8e6e7ef

Discovered and independently confirmed during the plan review for #792. P2 documentation contract defect; tracked separately outside Epic #848 S0. #792 remains scoped to honoring the input session filter.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    Fields

    Priority

    Medium

    Effort

    None yet

    Projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions