Skip to content

daverad/help-scout-mcp-server

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

107 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 knowledge base (Docs). Search tickets, manage customers, create draft replies, browse and manage KB articles, 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, email, or organization
  • Browse organizations and their members and conversation history
  • Pull full thread history into context before drafting a reply
  • Get conversation summaries with the original customer message and latest staff response
  • Create draft replies for human review before sending
  • Add internal notes and manage conversation status
  • Create and assign conversations to team members
  • Browse and search knowledge base articles from Help Scout Docs
  • Create, update, and manage KB content including articles, collections, and categories
  • Monitor inbox activity across multiple inboxes with a single query
  • Stay compliant with optional PII 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",
        "HELPSCOUT_DOCS_API_KEY": "your-docs-api-key",
        "HELPSCOUT_ENABLE_WRITES": "true"
      }
    }
  }
}

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

Conversations API (OAuth2)

  1. Go to Help Scout > My Apps > Create Private App
  2. Select at minimum: Read access to Mailboxes and Conversations
  3. For write tools: also grant Write access to Conversations
  4. Copy your App ID and App Secret

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

Help Scout UI Environment Variable
App ID HELPSCOUT_APP_ID
App Secret HELPSCOUT_APP_SECRET

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

Docs API (Knowledge Base)

The Docs API uses a separate API key (not OAuth2).

  1. Go to Help Scout > Manage > API Keys
  2. Generate or copy your Docs API key
  3. Set it as HELPSCOUT_DOCS_API_KEY

The Docs API key is optional. Without it, the server works normally but Docs tools won't appear. Both credential types can be used together.

Tools (up to 49 total)

Conversation Tools

Task Tool Example
List recent tickets searchConversations "Show me active tickets from this week"
Find by keyword comprehensiveConversationSearch "Find conversations about billing errors"
Look up a ticket number structuredConversationFilter "Show me ticket #42839"
Complex filters advancedConversationSearch "All @acme.com conversations tagged urgent"
Quick conversation overview getConversationSummary "Summarize this conversation"
Full message history getThreads "Show me the complete thread"
Current server time getServerTime Used for time-relative searches
List inboxes searchInboxes / listAllInboxes "What inboxes are available?"

Customer & Organization Tools

Task Tool Example
Get customer profile getCustomer "Look up customer 12345"
Search customers listCustomers "Find customers named Smith"
Find by email searchCustomersByEmail "Find customer with email john@acme.com"
Get contact details getCustomerContacts "Get all contact info for customer 12345"
Get organization getOrganization "Show me organization 789"
List organizations listOrganizations "List all organizations by activity"
Organization members getOrganizationMembers "Who is in organization 789?"
Organization conversations getOrganizationConversations "Show conversations for org 789"

Write Tools (Opt-in)

These tools require HELPSCOUT_ENABLE_WRITES=true and are hidden when writes are disabled.

Task Tool Example
Reply to a conversation createReply "Draft a reply to ticket #123"
Add internal note createNote "Add a note to ticket #123"
Change ticket status updateConversationStatus "Close ticket #123"
Create new conversation createConversation "Create a draft ticket for john@acme.com"
Assign to team member assignConversation "Assign ticket #123 to user 456"
List team members listUsers "Who can I assign tickets to?"
List mailboxes listMailboxes "Which mailbox should I create the ticket in?"

Safety defaults:

  • HELPSCOUT_ENABLE_WRITES defaults to false. Write tools are completely hidden until explicitly enabled.
  • createReply and createConversation default to draft mode (draft: true). Drafts must be manually sent from the Help Scout UI.
  • Setting draft: false sends a real email immediately and cannot be undone.
  • createNote creates internal notes only visible to support agents, never sent to customers.
  • Status changes may trigger Help Scout automations (e.g., satisfaction surveys on close).
  • POST operations (creates) do not retry to prevent duplicate records.

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

Docs API Tools (Opt-in)

These tools require HELPSCOUT_DOCS_API_KEY to be set. They use Help Scout's separate Docs API for knowledge base management.

Docs Read Tools

Task Tool Example
List KB collections docs_listCollections "Show me all knowledge base collections"
Get collection details docs_getCollection "Get details for collection abc123"
List categories docs_listCategories "What categories are in this collection?"
Get category details docs_getCategory "Get category info"
List articles docs_listArticles "Show articles in this collection"
Get article content docs_getArticle "Get the full article with HTML content"
Search articles docs_searchArticles "Find KB articles about password reset"
Get related articles docs_getRelatedArticles "What articles are related to this one?"
List article revisions docs_listArticleRevisions "Show revision history for this article"
Get a specific revision docs_getArticleRevision "Get revision xyz of this article"
List Docs sites docs_listSites "Show me all Docs sites"
Get site details docs_getSite "Get details for site abc"
List URL redirects docs_listRedirects "Show redirects for this site"

Docs Write Tools

These additionally require HELPSCOUT_ENABLE_WRITES=true.

Task Tool Example
Create collection docs_createCollection "Create a new KB collection"
Update collection docs_updateCollection "Rename the collection"
Delete collection docs_deleteCollection "Delete the empty collection"
Create category docs_createCategory "Add a category to this collection"
Update category docs_updateCategory "Rename the category"
Delete category docs_deleteCategory "Remove this category"
Create article docs_createArticle "Create a new KB article about returns"
Update article docs_updateArticle "Update the article content"
Delete article docs_deleteArticle "Delete the outdated article"
Create redirect docs_createRedirect "Add a redirect from old URL to new"
Update redirect docs_updateRedirect "Update the redirect destination"
Delete redirect docs_deleteRedirect "Remove this redirect"

Docs API authentication: The Docs API uses a separate API key with HTTP Basic Auth, independent from the OAuth2 credentials used for conversations. Get your Docs API key from Help Scout > Manage > API Keys.

Configuration

Variable Description Default
HELPSCOUT_APP_ID App ID from Help Scout My Apps Required
HELPSCOUT_APP_SECRET App Secret from Help Scout My Apps Required
HELPSCOUT_DOCS_API_KEY Docs API key for knowledge base access None (Docs tools disabled)
HELPSCOUT_DEFAULT_INBOX_ID Scope searches to a specific inbox None (all inboxes)
HELPSCOUT_BASE_URL Help Scout API endpoint https://api.helpscout.net/v2/
HELPSCOUT_DOCS_BASE_URL Docs API endpoint https://docsapi.helpscout.net/v1
HELPSCOUT_ENABLE_WRITES Enable write tools (conversations + Docs) false
REDACT_MESSAGE_CONTENT Hide message bodies in responses false
CACHE_TTL_SECONDS Cache duration for API responses 300
LOG_LEVEL Logging verbosity (error, warn, info, debug) info

Compatibility

Works with any MCP-compatible client:

Category Clients
AI Assistants Claude Desktop, Goose, and other MCP-enabled assistants
Code Editors Cursor, VS Code, Windsurf, Continue.dev
Command Line Claude Code, Codex, Gemini CLI, OpenCode
Custom Any application implementing the MCP standard

Security and Privacy

Built with compliance-minded teams in mind:

  • Optional PII redaction. Message bodies are included by default. Set REDACT_MESSAGE_CONTENT=true to hide them for stricter compliance requirements.
  • 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.

About

MCP server for Help Scout - read and write conversations in inbox and articles in docs with AI agents

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 82.4%
  • JavaScript 17.1%
  • Other 0.5%