Skip to content

docs: update architecture docs for Outfitter stack adoption#172

Open
galligan wants to merge 1 commit into
fire-11/mcp-frameworkfrom
fire-1/docs
Open

docs: update architecture docs for Outfitter stack adoption#172
galligan wants to merge 1 commit into
fire-11/mcp-frameworkfrom
fire-1/docs

Conversation

@galligan

@galligan galligan commented Feb 22, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Update AGENTS.md with handlers layer, @outfitter/cli and @outfitter/mcp references
  • Rewrite docs/mcp.md for 6-tool architecture with defineTool() pattern
  • Update docs/architecture/outfitter-patterns.md to reflect completed adoption phases (FIRE-1)

Test plan

  • bun run check passes
  • bun test passes (298 tests)

🤘🏻 In-collaboration-with: Claude Code

Greptile Summary

Updated architecture documentation to reflect completed Outfitter stack adoption phases (handlers layer, @outfitter/cli, @outfitter/mcp). The changes bring documentation in sync with recent refactoring work that introduced the handler contract pattern and framework integration.

Major changes:

  • AGENTS.md: Added handlers layer directory structure with 12 core handlers, updated MCP server section to reference defineTool() and tool annotations, added handler contract and Result types pattern documentation
  • docs/architecture/outfitter-patterns.md: New comprehensive guide documenting 8 Outfitter patterns (handler contract, error taxonomy, logging, CLI framework, MCP server, XDG config, validation, testing), current adoption status, and remaining migration tasks
  • docs/mcp.md: Removed outdated TODO about single-tool action-based architecture, rewrote to document current 6-tool architecture (fw_query, fw_status, fw_doctor, fw_help, fw_pr, fw_fb) with defineTool() pattern examples and tool annotations

Confidence Score: 5/5

  • Documentation-only changes with accurate reflections of completed code refactoring
  • All changes are documentation updates that accurately document completed implementation work (handlers layer, CLI/MCP framework adoption). The PR passed tests and checks. No code changes, no logical issues, and documentation aligns with actual codebase state.
  • No files require special attention

Important Files Changed

Filename Overview
AGENTS.md Updated architecture diagram and patterns section to reflect completed handler layer, @outfitter/cli, and @outfitter/mcp adoption with accurate references to new framework patterns
docs/architecture/outfitter-patterns.md Comprehensive new reference guide documenting Outfitter stack adoption patterns, current state, and remaining migration work with detailed examples and adoption status tracking
docs/mcp.md Rewritten to reflect 6-tool architecture with defineTool() pattern, replacing outdated single-tool action-based documentation with current implementation details

Last reviewed commit: 477682d

@linear

linear Bot commented Feb 22, 2026

Copy link
Copy Markdown

Update AGENTS.md with handlers layer, @outfitter/cli and @outfitter/mcp
references. Rewrite docs/mcp.md for 6-tool architecture with defineTool
pattern. Update outfitter-patterns.md to reflect completed adoption phases.

🤘🏻 In-collaboration-with: [Claude Code](https://claude.com/claude-code)
@galligan galligan force-pushed the fire-11/mcp-framework branch from c31cf2c to 0e54a57 Compare February 22, 2026 03:51
@galligan galligan marked this pull request as ready for review February 22, 2026 04:08

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 477682d8ab

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/mcp.md
{"action": "status", "status_short": true}
{"pr": 42, "action": "edit", "title": "feat: update auth"}
{"pr": 42, "action": "edit", "draft": true}
{"pr": 42, "action": "add", "review": "approve", "body": "LGTM"}

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Use valid fw_pr action values in write examples

The fw_pr schema only allows action values edit, rm, or review (apps/mcp/src/schemas.ts), so the documented "action": "add" payload is invalid and will be rejected during input validation. Any MCP client that copies this example to submit approvals (or similar write operations) will fail before reaching the handler, so the docs should use the currently supported action names.

Useful? React with 👍 / 👎.

Comment thread docs/mcp.md
{"action": "list"}
{"id": "@a7f3c", "action": "view"}
{"id": "@a7f3c", "body": "Fixed", "resolve": true}
{"id": "@a7f3c", "action": "ack"}

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Document ack with fw_fb boolean flag, not action field

fw_fb does not define an action parameter; acknowledgement is triggered by ack: true (FeedbackParamsShape), while unknown keys are ignored. With this example payload, action is dropped and handleCommentFeedback falls back to a view operation, so users expecting an ack will get a silent no-op instead.

Useful? React with 👍 / 👎.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant