helpscout-cli

MCP设计创作

提供方 mobilelocker

设计创作 stdio · 本地进程 OAuth 授权 社区 / 第三方 Claude DesktopClaudeCursorZed
查看接入方式

A command-line tool for HelpScout, covering Mailbox API v2 and Docs API v1, designed for scripting, automation, and use by AI agents.

一句话选型结论

按资料字段整理

helpscout-cli 属于设计创作类 MCP 服务器,stdio · 本地进程,OAuth 授权,可直接接入 Claude Desktop、Claude、Cursor 等,有可直接执行的安装命令。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类设计创作 传输方式stdio · 本地进程 鉴权OAuth 授权 部署方式本地部署
GitHub 星标 0 仓库热度,无公开仓库时显示未标注
工具数 未标注 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

设计创作
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量未标注暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

支持客户端

适用场景

Local DeploymentCLIHelpScout API

安装与配置

stdio · 本地进程 OAuth 授权
客户端在本机拉起子进程,数据不出本机
/usr/local/bin/helpscout-mcp

这条命令只是入口,具体启动参数请按官方文档补齐,不要直接照搬到别的服务器。

  1. 1
    准备运行环境

    stdio 服务在本地起进程,需要先装好 node,再按安装命令拉取依赖。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后随便调一个只读工具,确认能返回结果,再接入正式流程。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
出图与素材

生成配图、图标与素材。

设计稿处理

读取设计稿、批量改尺寸或导出。

内容生成

按主题生成文案与视觉草稿。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。
  • 已适配 Claude Desktop、Claude、Cursor,换客户端不用重新研究配置。

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 使用前要准备好OAuth 授权对应的凭据,并按最小权限配置。
  • 资料没标注工具数量,实际能力要装好后确认。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在设计创作场景里让模型直接调用外部能力的人。
  • 已经在用 Claude Desktop、Claude 的用户,接入路径最短。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 完全不想在本地装环境的人。
  • 不方便管理密钥或第三方授权的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
helpscout-cli当前 未标注 stdio · 本地进程 本地部署 有 2026-08-12
Cursor Talk To Figma MCP Da1c7911 40 未标注 未标注 无 2026-05-17
Blender MCP 17 stdio · 本地进程 本地部署 有 2026-05-18
Nova Canvas MCP Server 2 stdio · 本地进程 本地部署 有 2026-05-17
Figma Context MCP 3aaa8d28 未标注 未标注 支持远程部署 无 2026-05-17
kreuzberg 未标注 stdio · 本地进程 本地部署 有 2026-04-12

服务器档案

设计创作
字段来自项目仓库与公开索引,中文说明由本站标注
提供方mobilelocker上游标注的维护方 mobilelocker
分类设计创作本站按上游分类展示
连接方式stdio · 本地进程客户端在本机拉起子进程,数据不出本机
鉴权方式OAuth 授权远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · node本地安装时用到的包标识与运行时
部署类型本地部署上游给出的部署形态
最近核验2026-08-12上游最后核验时间

详细介绍

9.3 KB
来自项目仓库与上游目录的原文,未做删改

helpscout CLI

A command-line tool for Help Scout, covering the Mailbox API v2 (conversations, customers, users) and the full Docs API v1 (articles, collections, categories, redirects, sites, assets).

Designed for scripting, automation, and use by AI agents. Ships with an MCP server (helpscout-mcp) for direct integration with Claude Code, Claude Desktop, and Cursor. Outputs JSON by default when not in a terminal, pretty tables when it is.

Prerequisites

  • Node.js 20 or later
  • A Help Scout account with:
  • An OAuth application (for Mailbox API) — create one at Your Profile → My Apps
  • An API key (for Docs API) — create one at Your Profile → API Keys

Installation```sh

git clone https://github.com/mobilelocker/helpscout-cli.git helpscout-cli
cd helpscout-cli
./install.sh


`install.sh` runs `npm install`, builds both binaries (`helpscout` and `helpscout-mcp`), copies them to `/usr/local/bin`, stops any already-running `helpscout-mcp` processes (so you do not keep an old in-memory server after upgrade), and registers the MCP server with Claude Code and Cursor (when detected) — all in one step. If an editor had Help Scout MCP connected, reconnect it (or open a new session) so it starts the new binary.

### Development (run from source)```sh
git clone https://github.com/mobilelocker/helpscout-cli.git helpscout-cli
cd helpscout-cli
npm install
node bin/helpscout.js <command>

Configuration

The CLI reads credentials from environment variables. Add these to your shell profile or secrets manager:```sh

Required for Mailbox API (conversations, customers, users, etc.)

export HELPSCOUT_APP_ID="your-oauth-app-id"
export HELPSCOUT_APP_SECRET="your-oauth-app-secret"

Required for Docs API (articles, collections)

export HELPSCOUT_API_KEY="your-api-key"


## Authentication

The Mailbox API uses OAuth 2.0. Authenticate once and the token is cached for 48 hours (auto-refreshed):```sh
helpscout auth login     # opens browser, follow the prompt
helpscout auth status    # check when your token expires
helpscout auth logout    # remove the cached token

The Docs API uses your HELPSCOUT_API_KEY directly — no login step needed.

MCP Server

helpscout-mcp is an MCP server that exposes all Help Scout operations as tools for use with Claude Code, Claude Desktop, and Cursor.

After running install.sh, it is registered automatically with Claude Code (user scope) and Cursor (~/.cursor/mcp.json) when those editors are detected. To add it to a specific project instead:```json
{
"mcpServers": {
"helpscout": {
"command": "/usr/local/bin/helpscout-mcp"
}
}
}


The MCP server includes an `auth_login` tool that opens the browser OAuth flow on demand, so agents can handle authentication without leaving the conversation.

Docs article tools support full API fields — including `categories`, `related`, and `keywords` arrays on `create_article` and `update_article` (no raw HTTP/cURL needed). On update, omit `categories` to leave them unchanged, pass `null` or `clearCategories: true` to move to Uncategorized, or pass an array of category IDs to replace.

For long HTML/text bodies, prefer a file over inline text: MCP `filePath` (absolute path) or CLI `--file `. Provide either the inline field (`text`/`body`/`--text`/`--body`) or `filePath`/`--file`, not both. Applies to Docs article create/update/draft and Inbox reply/note/conversation create. Article create/update still use the JSON APIs (unlike multipart `upload_article`).

## Output Format

By default the CLI detects whether it's running in a terminal:

- **Terminal**: pretty tables with color
- **Pipe / script**: JSON

Override with flags available on every command:```sh
helpscout inbox mailbox list              # table in terminal, JSON in pipe
helpscout inbox mailbox list --json       # always JSON
helpscout inbox mailbox list --pretty     # always table
helpscout inbox mailbox list --markdown   # always Markdown table (GFM)

Errors are always written to stderr as JSON and exit with code 1:```json
{ "error": "Not authenticated. Run: helpscout auth login" }


## Usage

### Conversations```sh
# List active conversations
helpscout inbox conversation list --mailbox <mailbox-id>

# All pages, closed conversations, filtered by tag
helpscout inbox conversation list --status closed --tag billing --all

# Get a single conversation
helpscout inbox conversation get <id>

# Create a conversation
helpscout inbox conversation create \
  --subject "Welcome!" \
  --mailbox-id <mailbox-id> \
  --customer-email user@example.com \
  --body "<p>Thanks for signing up.</p>"
# or: --file ./welcome.html

# Reply and add an internal note
helpscout inbox thread reply <id> --text "<p>We're looking into this.</p>"
helpscout inbox thread reply <id> --file ./reply.html
helpscout inbox thread note <id> --text "<p>Escalated to engineering.</p>"
helpscout inbox thread note <id> --file ./note.html

# Close a conversation
helpscout inbox conversation update <id> --status closed

Customers```sh

helpscout inbox customer list --email user@example.com
helpscout inbox customer get <id>
helpscout inbox customer create --email new@example.com --first-name Jane --last-name Doe
helpscout inbox customer update <id> --phone "+15555550100"


### Users &amp; Mailboxes```sh
helpscout inbox user me                        # who am I?
helpscout inbox user list                      # all users
helpscout inbox mailbox list                   # all mailboxes with their IDs

helpscout inbox user status get &lt;id&gt;           # email + chat status for a user
helpscout inbox user status list               # statuses for all users
helpscout inbox user status set &lt;id&gt; --status active --text &quot;On a call&quot; --emoji 📞

Tags```sh

helpscout inbox tag list


### Webhooks```sh
helpscout inbox webhook list
helpscout inbox webhook create \
  --url https://example.com/hook \
  --secret mysecret \
  --events convo.created,convo.assigned \
  --payload-version v3   # opt into V3 payloads (preserves system_user type)
helpscout inbox webhook delete &lt;id&gt;

Docs Articles```sh

List articles in a collection (default status: all)

helpscout docs article list --collection <collection-id> --all

Search

helpscout docs article search --query "getting started" --site <site-id>

Create with one or more categories (repeat --category for each id)

helpscout docs article create \
--collection <collection-id> \
--name "New Feature Guide" \
--text "<p>Content here.</p>" \
--category <category-id> \
--category <other-category-id> \
--keyword "feature" \
--reload

Create / update / draft body from a file (alternative to --text)

helpscout docs article create --collection <collection-id> --name "Guide" --file ./body.html
helpscout docs article update <id> --file ./body.html
helpscout docs article save-draft <id> --file ./draft.html

Update categories: assign, leave unchanged, or move to Uncategorized

helpscout docs article update <id> --status published
helpscout docs article update <id> --category cat-a --category cat-b # replace category list
helpscout docs article update <id> --clear-categories # null → Uncategorized

helpscout docs article delete <id>


**MCP (`create_article` / `update_article` / `save_article_draft`):** pass `categories` as a string array, e.g. `&quot;categories&quot;: [&quot;&quot;]`. On update, omit the field to leave categories unchanged; use `&quot;categories&quot;: null` or `&quot;clearCategories&quot;: true` for Uncategorized. For body HTML, pass either `text` or `filePath` (absolute path on disk). Same `filePath` pattern on inbox `reply_to_conversation`, `add_note`, and `create_conversation` (`body` or `filePath`).

### Docs Collections, Categories, Redirects, Sites```sh
helpscout docs collection list
helpscout docs collection create --site &lt;site-id&gt; --name &quot;FAQ&quot;

helpscout docs category list --collection &lt;collection-id&gt;
helpscout docs category create --collection &lt;id&gt; --name &quot;Getting Started&quot;

helpscout docs redirect list --site &lt;site-id&gt;
helpscout docs redirect create --site &lt;id&gt; --url-mapping /old --redirect https://example.com/new

helpscout docs site create --title &quot;Docs&quot; --subdomain docs --bg-color &quot;#444444&quot; --has-contact-form
helpscout docs site restrictions update &lt;site-id&gt; --enabled --authentication CALLBACK --sign-in-url https://example.com/signin

Docs Assets```sh

helpscout docs asset create-article --file ./screenshot.png
helpscout docs asset create-settings --file ./logo.png


## Development```sh
npm test              # unit tests (offline; no live Help Scout calls)
npm run test:integration  # live API tests (requires HELPSCOUT_* credentials)
npm run scrape:docs-api  # refresh docs/docs-api-endpoints.json from Help Scout docs
npm run lint          # check for lint errors
npm run lint:fix  # auto-fix lint errors
npm run format    # format with Prettier
npm run build     # bundle to dist/helpscout and dist/helpscout-mcp

Pre-commit hooks run ESLint and Prettier automatically on staged files.

Author

Built by Mobile Locker — support@mobilelocker.com

Mobile Locker is a content management and engagement platform for the life sciences industry. We help pharmaceutical, medical device, and diagnostics companies deliver personalized content to healthcare professionals — with down-to-the-page analytics, CRM integrations (Salesforce, Veeva), and AI-powered recommendations built for regulated environments.

License

MIT

常见问题

8 问
答案由本站依据条目字段整理,不引用上游原文
helpscout-cli 怎么安装?

在客户端按下面的安装命令接入:/usr/local/bin/helpscout-mcp。装完在客户端配置里引用同一个包或端点。

helpscout-cli 怎么在 Claude Desktop、Claude、Cursor 里配置?

它的传输方式是stdio · 本地进程,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

helpscout-cli 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

helpscout-cli 需要 API Key 吗?

资料标注需要OAuth 授权认证,使用前准备好对应凭据,并按最小权限配置。

helpscout-cli 支持哪些客户端?

资料标注支持 Claude Desktop、Claude、Cursor、Zed;其他客户端只要能配置 MCP Server,也能用同样的命令或地址接入。

helpscout-cli 能提供哪些能力?

资料显示能力标签包括 Local Deployment、CLI、HelpScout API、JavaScript、Automation、AI Agents。具体工具清单以官方文档为准。

helpscout-cli 需要什么运行环境?

运行时为 node;属于本地进程,需要在本机装好运行环境。

helpscout-cli 是本地还是远程?

它是本地进程(stdio),由客户端在本机拉起。传输方式为stdio · 本地进程。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-08-12。