smaregi-mcp

smaregi-mcp

Enables interaction with the Smaregi POS API to manage products, sales, inventory, and member information directly through Claude Code. It provides a suite of CRUD tools and comprehensive API documentation to streamline retail management via natural language.

Category
访问服务器

README

smaregi-mcp

スマレジ API を Claude Code から操作するための MCP サーバーと Skills。

商品管理・売上確認・在庫操作・会員管理・店舗設定など、スマレジの各種 API を Claude Code の会話から直接利用できます。

Note: このプロジェクトはスマレジ株式会社の公式ツールではありません。スマレジ Developer Platform の公開 API 仕様をもとに作成した非公式の連携ツールです。

構成

smaregi-mcp/
├── MCP サーバー (src/, bin/)    ... APIを実際に叩く「手足」
└── Skills (skills/)             ... APIの使い方を知る「知識」
  • MCP サーバー: 9つの汎用ツール(GET/POST/PUT/DELETE/PATCH + 管理系)を提供
  • Skills: API リファレンス 63 ファイル + 操作ガイド 12 ファイル

対応 API

API Skills MCP
POS(商品・取引・会員・在庫・店舗等) 対応 対応
在庫管理(ロス・発注・入荷・出荷・棚卸) 対応 未対応 (*1)
ウェイター(メニュー・テーブル・注文・予約) 対応 未対応 (*1)
受注出荷(受注・出荷・決済) 対応 未対応 (*1)
タイムカード(打刻・勤怠・給与・日報) 対応 未対応 (*1)

*1: MCP サーバーのベースパスが /pos 固定のため。Skills のリファレンスは全 API 分を網羅済み。

セットアップ

前提条件

  • Node.js 18 以上
  • Claude Code インストール済み
  • スマレジ Developer Platform でアプリ作成済み(クライアント ID / シークレット取得済み)

1. Skills のインストール

npx smaregi-mcp setup-skills

~/.claude/skills/smaregi-api-skill/ に API リファレンスと操作ガイドがインストールされます。

2. MCP サーバーの登録

~/.claude/settings.jsonmcpServers に追加:

{
  "mcpServers": {
    "smaregi": {
      "command": "npx",
      "args": ["smaregi-mcp"]
    }
  }
}

3. Claude Code を再起動

4. 認証設定

Claude Code の会話で:

スマレジの認証設定をして

契約 ID・クライアント ID・クライアントシークレットを入力すると ~/.config/smaregi-mcp/config.json に保存されます。

5. 動作確認

スマレジの店舗一覧を取得して

ソースからビルドする場合

git clone https://github.com/fujioka0729/smaregi-mcp.git
cd smaregi-mcp
npm install
npm run build

MCP ツール一覧

ツール 説明
smaregi_api_get GET リクエスト(データ取得)
smaregi_api_post POST リクエスト(データ作成)
smaregi_api_put PUT リクエスト(データ更新)
smaregi_api_delete DELETE リクエスト(データ削除)
smaregi_api_patch PATCH リクエスト(部分更新)
smaregi_api_list_paths 利用可能なエンドポイント一覧
smaregi_configure 認証情報設定
smaregi_auth_status 認証状態確認
smaregi_server_info サーバー情報表示

Skills 構成

skills/smaregi-api-skill/
├── SKILL.md                    # スキル定義・全体目次
├── references/ (63 ファイル)    # API エンドポイント仕様書
│   ├── common-*                # 認証・Webhook
│   ├── pos-*                   # POS API
│   ├── inventory-*             # 在庫管理 API
│   ├── waiter-*                # ウェイター API
│   ├── order-*                 # 受注出荷 API
│   └── timecard-*              # タイムカード API
└── recipes/ (12 ファイル)       # 操作手順ガイド
    ├── product-operations.md   # 商品管理
    ├── transaction-operations.md # 取引操作
    ├── customer-operations.md  # 会員管理
    ├── stock-operations.md     # 在庫操作
    ├── store-operations.md     # 店舗管理
    ├── coupon-operations.md    # クーポン操作
    ├── inventory-management-operations.md # 在庫管理
    ├── waiter-operations.md    # ウェイター操作
    ├── order-management-operations.md     # 受注出荷操作
    ├── staff-timecard-operations.md       # タイムカード操作
    ├── webhook-setup.md        # Webhook 設定
    └── troubleshooting.md      # トラブルシューティング

スマレジアプリの作成

  1. developers.smaregi.dev でアプリを新規登録(種別: Web アプリ)
  2. 必要なスコープを有効化:
    • pos.products:read / pos.products:write
    • pos.customers:read / pos.customers:write
    • pos.stores:read
    • pos.transactions:read / pos.transactions:write
    • pos.staffs:read
    • pos.stock:read / pos.stock:write
  3. クライアント ID / シークレットを控える

トラブルシューティング

MCP サーバーが認識されない

  • settings.json のパスが正しいか確認
  • Claude Code を再起動したか確認
  • node /path/to/bin/smaregi-mcp.js を直接実行してエラーが出ないか確認

認証エラー (401)

  • トークンキャッシュを削除: rm ~/.config/smaregi-mcp/tokens.json
  • クライアント ID / シークレットが正しいか確認

スコープ不足 (403)

  • Developer Platform でアプリのスコープ設定を確認
  • スコープ変更後はトークンキャッシュを削除: rm ~/.config/smaregi-mcp/tokens.json

レート制限 (429)

環境 GET POST/PUT/PATCH/DELETE
サンドボックス 10 回/秒 4 回/秒
本番 50 回/秒 20 回/秒

Retry-After ヘッダーの秒数だけ待ってから再試行してください。

ライセンス

MIT

推荐服务器

Baidu Map

Baidu Map

百度地图核心API现已全面兼容MCP协议,是国内首家兼容MCP协议的地图服务商。

官方
精选
JavaScript
Playwright MCP Server

Playwright MCP Server

一个模型上下文协议服务器,它使大型语言模型能够通过结构化的可访问性快照与网页进行交互,而无需视觉模型或屏幕截图。

官方
精选
TypeScript
Magic Component Platform (MCP)

Magic Component Platform (MCP)

一个由人工智能驱动的工具,可以从自然语言描述生成现代化的用户界面组件,并与流行的集成开发环境(IDE)集成,从而简化用户界面开发流程。

官方
精选
本地
TypeScript
Audiense Insights MCP Server

Audiense Insights MCP Server

通过模型上下文协议启用与 Audiense Insights 账户的交互,从而促进营销洞察和受众数据的提取和分析,包括人口统计信息、行为和影响者互动。

官方
精选
本地
TypeScript
VeyraX

VeyraX

一个单一的 MCP 工具,连接你所有喜爱的工具:Gmail、日历以及其他 40 多个工具。

官方
精选
本地
graphlit-mcp-server

graphlit-mcp-server

模型上下文协议 (MCP) 服务器实现了 MCP 客户端与 Graphlit 服务之间的集成。 除了网络爬取之外,还可以将任何内容(从 Slack 到 Gmail 再到播客订阅源)导入到 Graphlit 项目中,然后从 MCP 客户端检索相关内容。

官方
精选
TypeScript
Kagi MCP Server

Kagi MCP Server

一个 MCP 服务器,集成了 Kagi 搜索功能和 Claude AI,使 Claude 能够在回答需要最新信息的问题时执行实时网络搜索。

官方
精选
Python
e2b-mcp-server

e2b-mcp-server

使用 MCP 通过 e2b 运行代码。

官方
精选
Neon MCP Server

Neon MCP Server

用于与 Neon 管理 API 和数据库交互的 MCP 服务器

官方
精选
Exa MCP Server

Exa MCP Server

模型上下文协议(MCP)服务器允许像 Claude 这样的 AI 助手使用 Exa AI 搜索 API 进行网络搜索。这种设置允许 AI 模型以安全和受控的方式获取实时的网络信息。

官方
精选