Help Scout MCP Server

Un serveur MCP qui permet aux assistants IA d'interagir avec les données de Help Scout, comme les clients et les conversations.

Documentation

Help Scout MCP Server

npm version Docker Ask DeepWiki License: MIT

An MCP server that gives AI assistants direct access to your Help Scout inboxes, conversations, customers, organizations, threads, and Docs knowledge base. Search tickets, pull customer and account context, inspect articles, spot patterns, and get answers without leaving your editor or chat window.

Built by a Help Scout customer who wanted to give his support team superpowers. If you handle customer conversations in Help Scout and want AI to help you work faster, this is for you.

What You Can Do

  • Search conversations by keyword, date range, status, tag, email domain, or ticket number
  • Look up customers by name, advanced query syntax, or exact email address
  • Explore organizations with direct customer and conversation traversal
  • Inspect conversation detail with raw ticket metadata, summaries, full threads, attachments, and original source
  • Pull full thread history into context before drafting a reply
  • Get conversation summaries with the original customer message and latest staff response
  • Search and retrieve Docs articles from the separate Help Scout Docs API
  • Pull Help Scout reports and metadata for company, conversations, Docs, channels, productivity, happiness, users, teams, system users, statuses, routing, and webhooks
  • Monitor inbox activity across multiple inboxes with a single query
  • Reduce message payloads with optional message content redaction and scoped inbox access

Quick Start

Claude Cowork (Recommended)

Install the helpscout-navigator plugin. It auto-starts the MCP server and includes navigation skills that help Claude pick the right search tool for your query.

  1. Open Cowork and go to Customize > Browse plugins > Personal
  2. Click + > Add marketplace from GitHub and enter drewburchfield/help-scout-mcp-server
  3. Install helpscout-navigator from the marketplace
  4. Add your Help Scout credentials (step-by-step guide)

The plugin bundles guided skills, session hooks, and tool selection guidance on top of the MCP server. Other install methods give you the tools; this one also teaches the AI how to use them well.

Claude Desktop

One-click install using Desktop Extensions:

  1. Download the latest .mcpb file from releases
  2. Double-click to install (or drag into Claude Desktop)
  3. Enter your Help Scout App ID and App Secret when prompted

Claude Code

The same helpscout-navigator plugin works in Claude Code with the same navigation skills.

  1. Run /plugin in Claude Code to open the marketplace
  2. Search for helpscout-navigator and install it
  3. Set HELPSCOUT_APP_ID and HELPSCOUT_APP_SECRET as environment variables
  4. Restart Claude Code

For Cursor, VS Code, and Other MCP Clients

Add to your MCP client's config file (e.g., claude_desktop_config.json, .cursor/mcp.json):

{
  "mcpServers": {
    "helpscout": {
      "command": "npx",
      "args": ["help-scout-mcp-server"],
      "env": {
        "HELPSCOUT_APP_ID": "your-app-id",
        "HELPSCOUT_APP_SECRET": "your-app-secret"
      }
    }
  }
}

Docker

docker run -e HELPSCOUT_APP_ID="your-app-id" \
  -e HELPSCOUT_APP_SECRET="your-app-secret" \
  drewburchfield/help-scout-mcp-server

Getting Your API Credentials

  1. Go to Help Scout > My Apps > Create Private App
  2. Select at minimum: Read access to Mailboxes, Conversations, Customers, and Organizations
  3. Copy your App ID and App Secret

Help Scout uses OAuth2 Client Credentials flow exclusively. Personal Access Tokens are not supported.

Help Scout UIEnvironment Variable
App IDHELPSCOUT_APP_ID
App SecretHELPSCOUT_APP_SECRET

Alternative names HELPSCOUT_CLIENT_ID / HELPSCOUT_CLIENT_SECRET and legacy HELPSCOUT_API_KEY are also supported.

Docs knowledge base tools use Help Scout Docs API v1, which is separate from the Mailbox API. Set HELPSCOUT_DOCS_API_KEY only if you want to use listDocs*, searchDocsArticles, getDocsArticle, or redirect tools.

Tools

For the MCP compatibility contract and roadmap, see:

Which tool should I use?

TaskToolExample
List recent ticketssearchConversations"Show me active tickets from this week"
Find by keywordcomprehensiveConversationSearch"Find conversations about billing errors"
Look up a ticket numberstructuredConversationFilter"Show me ticket #42839"
Complex filtersadvancedConversationSearch"All @acme.com conversations tagged urgent"
Browse customerslistCustomers"Show customers named Jane"
Find a customer by emailsearchCustomersByEmail"Find customer [email protected]"
Inspect a customer profilegetCustomer"Open customer 12345"
Pull customer contact channelsgetCustomerContacts"Show contact details for customer 12345"
Browse organizationslistOrganizations"Show the busiest organizations"
Inspect an organizationgetOrganization"Open organization 456"
List customers in an organizationgetOrganizationMembers"Who belongs to organization 456?"
List organization conversationsgetOrganizationConversations"Show support history for organization 456"
Raw conversation detailgetConversation"Open conversation 12345 with full metadata"
Quick conversation overviewgetConversationSummary"Summarize this conversation"
Full message historygetThreads"Show me the complete thread"
Inspect routing stategetInboxRouting"Show routing for inbox 359402"
Search Docs articlessearchDocsArticles"Find knowledge base articles about refunds"
Retrieve a Docs articlegetDocsArticle"Open Docs article 123"
Current MCP host timegetServerTimeUsed for time-relative searches

Inboxes are auto-discovered when the server connects. AI agents get inbox IDs in their instructions automatically, so no lookup step is needed.

Configuration

VariableDescriptionDefault
HELPSCOUT_APP_IDApp ID from Help Scout My AppsRequired
HELPSCOUT_APP_SECRETApp Secret from Help Scout My AppsRequired
HELPSCOUT_DEFAULT_INBOX_IDScope searches to a specific inboxNone (all inboxes)
HELPSCOUT_BASE_URLHelp Scout API endpointhttps://api.helpscout.net/v2/
HELPSCOUT_DOCS_API_KEYOptional Docs API key for knowledge base toolsNone
HELPSCOUT_DOCS_BASE_URLHelp Scout Docs API endpointhttps://docsapi.helpscout.net/v1/
REDACT_MESSAGE_CONTENTReplace message bodies with placeholdersfalse
CACHE_TTL_SECONDSCache duration for API responses300
LOG_LEVELLogging verbosity (error, warn, info, debug)info

Compatibility

Works with any MCP-compatible client:

CategoryClients
AI AssistantsClaude Desktop, Goose, and other MCP-enabled assistants
Code EditorsCursor, VS Code, Windsurf, Continue.dev
Command LineClaude Code, Codex, Gemini CLI, OpenCode
CustomAny application implementing the MCP standard

Security and Privacy

Built with security-minded teams in mind:

  • Optional message content redaction. Message bodies are included by default. Set REDACT_MESSAGE_CONTENT=true to replace conversation and thread bodies with placeholders for lower-context analysis. This is not a compliance boundary and does not remove all customer identifiers.
  • Secure authentication. OAuth2 Client Credentials with automatic token refresh.
  • Rate limit handling. Automatic retry with exponential backoff on 429 responses.
  • Scoped access. Optional default inbox configuration limits what the AI can search.

Troubleshooting

Authentication failed? Verify your credentials work with Help Scout directly:

curl -X POST https://api.helpscout.net/v2/oauth2/token \
  -d "grant_type=client_credentials&client_id=$HELPSCOUT_APP_ID&client_secret=$HELPSCOUT_APP_SECRET"

Empty search results? Common causes:

  • Using the wrong search tool (use searchConversations for listing, comprehensiveConversationSearch for keyword search)
  • Inbox ID mismatch. Check the IDs from server instructions, not guessed values.
  • Search terms too narrow. Try broader terms or a longer time range.

Need more detail? Enable debug logging:

LOG_LEVEL=debug npx help-scout-mcp-server

Development

git clone https://github.com/drewburchfield/help-scout-mcp-server.git
cd help-scout-mcp-server
npm install && npm run build
npm start
npm test           # Run tests
npm run type-check # TypeScript validation
npm run lint       # Linting
npm run dev        # Development server with auto-reload

Contributions welcome. Please ensure tests, type checking, and linting pass before submitting a PR.

Support

License

MIT License - see LICENSE for details.