Release v2.3.0

[zackkatz]

Summary

• Consolidate MCP tools and reduce protocol overhead
• Add compatibility coverage for merged Docs and Reports tools
• Refresh README guidance and add Claude Code setup option
• Fix double-compacting of Docs and Reports tool descriptions

Summary by CodeRabbit

• New Features

  • Added ability to create internal notes on conversations.
  • Unified report retrieval with dynamic type-based endpoint.
  • Enhanced documentation tools with consolidated entity operations.

• Removed/Deprecated

  • Removed listAllInboxes tool; use searchInboxes instead.

• Documentation

  • Updated setup guidance with expanded configuration options and examples.
  • Added operational guidelines documentation.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7e5a921d-e17c-4409-b195-325b786b7110

📥 Commits

Reviewing files that changed from the base of the PR and between d4fa5fb and 3e40cdf.

📒 Files selected for processing (16)

• AGENTS.md
• README.md
• README_REPORTS_FEATURE.md
• helpscout-mcp-extension/manifest.json
• mcp.json
• src/__tests__/docs-tools.test.ts
• src/__tests__/mcpb-validation.test.ts
• src/__tests__/tools.test.ts
• src/index.ts
• src/prompts/index.ts
• src/schema/types.ts
• src/tools/docs-tools.ts
• src/tools/index.ts
• src/tools/reports-tools.ts
• src/tools/tool-utils.ts
• src/utils/api-constraints.ts

---

Walkthrough

Consolidates the Help Scout MCP server's tool surface by unifying multiple Docs API endpoints into entity-type-aware handlers, merging Reports tools into a single getReport endpoint with type parameters, removing listAllInboxes in favor of searchInboxes, adding new conversation tools (createNote, conversation operations), and introducing schema compacting mechanisms to reduce verbosity. Updates tests, configurations, and documentation accordingly.

Changes

Cohort / File(s)	Summary
Documentation AGENTS.md, README.md	Added operational guidelines for the MCP server in AGENTS.md. Expanded README with new Quick Start options, consolidated tool listings reflecting API surface changes, updated tool names and capabilities (e.g., listDocsCollections, getReport unified endpoint), removed deprecated entries, and adjusted configuration examples.
Deprecated Documentation README_REPORTS_FEATURE.md	Removed file documenting Reports API feature, consolidating its content into unified tool documentation.
Configuration & Manifests helpscout-mcp-extension/manifest.json, mcp.json	Updated tool definitions: removed listAllInboxes, added createNote, reordered and added new conversation tools (createReply, getConversation, createConversation, updateConversation).
Core Tool Implementations src/tools/index.ts	Replaced listAllInboxes with searchInboxes, added createNote tool and execution handler, introduced CONVERSATION_TOOL_DESCRIPTIONS mapping, removed universal verbose parameter augmentation, integrated tool compacting via descriptions, and added legacy tool name detection for Docs/Reports routing.
Docs Tools Consolidation src/tools/docs-tools.ts	Refactored to unified, entity-type-aware handlers: merged listDocsArticles/listDocsArticlesByCategory, consolidated getDocsEntity replacing getDocsSite/getDocsCollection/getDocsCategory, unified updateDocsEntity for collections and categories with dynamic endpoint resolution, and centralized DOCS_TOOL_DESCRIPTIONS.
Reports Tools Consolidation src/tools/reports-tools.ts	Unified multiple report endpoints into single getReport handler with type-based dispatching, added helper utilities (withReportType, buildBaseParams, addCsvParam), introduced REPORT_TOOL_DESCRIPTIONS mapping, and refactored to support flexible report type handling.
Tool Utilities src/tools/tool-utils.ts	New utility module introducing compactTool() function to reduce schema and description verbosity, with recursive schema compaction and boilerplate phrase removal.
Schemas src/schema/types.ts	Added CreateNoteInputSchema and CreateNoteInput type, made SearchInboxesInputSchema.query optional with empty string default, changed ListDocsArticlesInputSchema.pageSize default from 50 to 100.
Configuration & Guidance src/index.ts, src/prompts/index.ts, src/utils/api-constraints.ts	Updated tool references from listAllInboxes to searchInboxes, replaced report tool names (getConversationReport/getHappinessReport → getReport/getHappinessRatings), and updated validation guidance for inbox ID discovery.
Tests - Tool Definitions src/__tests__/mcpb-validation.test.ts, src/__tests__/tools.test.ts	Updated core tool expectations: removed listAllInboxes, added createNote; refactored listAllInboxes behavior into legacy alias suite routing through searchInboxes; added verbose schema validation; introduced merged reports tools tests for getReport and getCompanyReport.
Tests - Docs Tools src/__tests__/docs-tools.test.ts	New comprehensive test suite validating unified Docs tools: listDocsArticles, getDocsEntity, updateDocsEntity with both current and legacy alias behaviors, mocking HTTP interactions and verifying response transformations.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~50 minutes

✨ Finishing Touches

• 📝 Generate docstrings (stacked PR)
• 📝 Generate docstrings (commit on current branch)

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch develop

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}