Skip to main content
Glama

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 ファイル

Related MCP server: MCP Officegest

対応 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

Available Tools

9 tools
smaregi_api_deleteC

スマレジAPIにDELETEリクエストを送信します

ParametersJSON Schema
NameRequiredDescriptionDefault
pathYesAPIパス(例: /products/{productId})
queryNoクエリパラメータ

TDQS

C2.6/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description must carry the full burden of behavioral disclosure. It merely states the HTTP method and gives no information about side effects, authorization needs, or what happens upon success/failure.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is very short (one sentence), which is concise but at the expense of completeness. It could be more informative without being verbose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the presence of sibling tools for different HTTP methods and no annotations, the description lacks context. It does not specify the purpose of DELETE, typical use cases, or any return value information.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema already provides descriptions for both parameters (path and query) with 100% coverage. The description adds no additional meaning beyond what is already in the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action (sends a DELETE request) and the target (Smaregi API). However, it does not differentiate from sibling tools like smaregi_api_get or smaregi_api_post, which also send requests of their respective methods.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to use this tool versus alternatives. It does not explain that DELETE is typically used for deleting resources, nor does it mention any prerequisites or context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

smaregi_api_getC

スマレジAPIにGETリクエストを送信します

ParametersJSON Schema
NameRequiredDescriptionDefault
pathYesAPIパス(例: /products)
queryNoクエリパラメータ

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description must disclose behavioral traits. It only mentions that it sends a GET request, omitting authentication requirements, rate limits, error handling, or idempotency. This is insufficient for safe usage.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single sentence with no wasted words. It is concise, though it could benefit from slightly more detail without sacrificing brevity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has 2 parameters, no output schema, and moderate complexity, the description is too minimal. It does not explain the response format, authentication flow, or how to structure queries. A user unfamiliar with the Smaregi API would lack essential context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so baseline is 3. The description adds no additional meaning beyond what the schema already provides for 'path' and 'query'. It does not explain expected format or constraints.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Description clearly states it sends GET requests to Smaregi API. It distinguishes from sibling tools that use other HTTP methods (delete, patch, post, put). However, it lacks specificity about what resources it can access beyond the 'path' parameter.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to use this tool versus alternatives like 'smaregi_api_list_paths' or other HTTP methods. No context on prerequisites, typical use cases, or when not to use it.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

smaregi_api_list_pathsA

スマレジAPIの既知エンドポイント一覧を表示します

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

A3.6/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It does not state that the tool is read-only, has no side effects, or what kind of output to expect, leaving significant gaps for an AI agent.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single concise sentence with no wasted words. It is front-loaded with the verb and resource, making the purpose immediately clear.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple listing tool with no parameters and no output schema, the description is reasonably complete. It tells the agent what the tool does, though it could benefit from minor clarifications about output or side effects.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has no parameters, so the description need not add parameter info. The schema coverage is 100% by virtue of being empty, and the description adequately complements this by stating the tool's function.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool displays a list of known Smaregi API endpoints, specifying the verb (displays) and resource (list of known endpoints). This distinguishes it from sibling CRUD and configuration tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives. It does not mention that it is useful for discovering available endpoints before making specific API calls, nor does it provide any context for its use.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

smaregi_api_patchC

スマレジAPIにPATCHリクエストを送信します

ParametersJSON Schema
NameRequiredDescriptionDefault
bodyYesリクエストボディ
pathYesAPIパス(例: /products/{productId})
queryNoクエリパラメータ

TDQS

C2.8/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are present, so the description must carry the burden of behavioral disclosure. It only states that it sends a PATCH request, omitting details on side effects, success/failure responses, rate limits, or authentication requirements.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single concise sentence, but it lacks structure and necessary detail for a mutation tool with multiple parameters. It is not overly verbose, but could benefit from more information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity of a PATCH request mutation tool with three parameters and no output schema, the description is incomplete. It fails to explain return values, error handling, or typical usage patterns, leaving gaps for the AI agent.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% with each parameter having a basic description. The tool description does not add additional meaning beyond the schema, so the baseline of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description specifies that the tool sends a PATCH request to the Smaregi API, which clearly states the verb and resource. It distinguishes itself from sibling tools by the HTTP method, but lacks context on what specific resources or endpoints are appropriate.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives (e.g., PUT for full updates) or when not to use it. Prerequisites such as authentication or required permissions are not mentioned.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

smaregi_api_postC

スマレジAPIにPOSTリクエストを送信します

ParametersJSON Schema
NameRequiredDescriptionDefault
bodyYesリクエストボディ
pathYesAPIパス(例: /products)
queryNoクエリパラメータ

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries full responsibility. It only states the basic action of sending a POST request. No information about authentication, error handling, side effects, or response behavior is disclosed.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single concise sentence that front-loads the key action. No unnecessary words are present, though it could be expanded with more detail while maintaining brevity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity (3 parameters, required object, no output schema, no annotations), the description is incomplete. It does not explain the purpose of the body or query parameters, nor what response to expect, leaving significant gaps for the agent.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, but the descriptions are minimal ('request body', 'API path', 'query parameters'). The tool description adds no additional meaning beyond the schema. Baseline 3 is appropriate as the schema already documents parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb '送信します' (sends) and the resource 'スマレジAPIにPOSTリクエスト' (POST request to Smaregi API). However, it does not differentiate itself from sibling tools like smaregi_api_put or smaregi_api_patch, which also send requests.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. No context about typical use cases (e.g., creating resources) or when not to use it is given, leaving the agent without decision support.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

smaregi_api_putC

スマレジAPIにPUTリクエストを送信します

ParametersJSON Schema
NameRequiredDescriptionDefault
bodyYesリクエストボディ
pathYesAPIパス(例: /products/{productId})
queryNoクエリパラメータ

TDQS

C2.6/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations provided, so description carries full burden. It only says 'sends a PUT request' without disclosing behavioral traits like resource replacement, authentication needs, rate limits, or error behavior. This is insufficient.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Single sentence, very concise. No wasted words, but could benefit from more detail without losing conciseness. Structure is not an issue.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no output schema, 3 parameters, and no annotations, the description is too minimal. It lacks explanation of response, side effects, or complete usage context. Incomplete for effective tool selection.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with descriptions for all parameters. The description adds no extra parameter-level meaning beyond the schema, so baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

Description states verb (PUT) and target (Smaregi API), but does not specify what the PUT request accomplishes or differentiate from sibling tools like patch or post. It is clear but generic.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to use PUT versus PATCH or POST. No context about idempotency, prerequisites, or alternatives. The description is silent on usage decisions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

smaregi_auth_statusA

スマレジAPIの認証状態を確認します

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

A3.7/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full burden but only states it checks status. It does not disclose read-only behavior, possible return values, or side effects, which is minimal for a status-checking tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, front-loaded sentence that efficiently conveys the tool's purpose with no unnecessary words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no parameters and no output schema, the description is adequate but missing details about what the authentication status check returns or any error states, leaving the agent to infer behavior.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

There are no parameters, so the schema coverage is 100%. The description correctly implies no input is needed, meeting the baseline for parameter semantics.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states it checks authentication status using a specific verb and resource, distinguishing it from sibling tools that perform API operations or configure settings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

While the purpose is clear, the description does not provide explicit guidance on when to use this tool versus alternatives, such as before making API calls, nor does it mention exclusions or prerequisites.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

smaregi_configureA

スマレジAPIの接続設定を保存します

ParametersJSON Schema
NameRequiredDescriptionDefault
client_idYesクライアントID
contract_idYes契約ID
client_secretYesクライアントシークレット

TDQS

A3.5/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description must carry the behavioral burden. It only says 'save' without explaining whether it creates or updates, what happens on duplicate, or security implications. Minimal behavioral disclosure.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single sentence with no wasted words. It is concise and front-loaded with the core purpose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a configuration tool with three required parameters and no output schema, the description is adequate but lacks detail on idempotency, authentication needs, or side effects. More context would improve completeness.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with each parameter having a basic description. The description adds no extra meaning beyond the schema, so a baseline score of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool saves connection settings for the Smaregi API, using a specific verb and resource. It effectively distinguishes from sibling tools that handle API operations.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage as a setup tool but provides no explicit guidance on when to use or not use it, nor mentions alternatives. The sibling context makes the purpose clear, but guidelines are lacking.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

smaregi_server_infoA

MCPサーバーのバージョンと接続先情報を表示します

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

A4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations provided. Description indicates a read-only, non-destructive display of info, but does not mention auth requirements or side effects.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Single sentence conveys the entire purpose without redundancy. Perfectly concise and front-loaded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a zero-param info tool, the description is largely complete. Could be improved by noting whether authentication is required, but overall sufficient.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

No parameters exist (schema coverage 100%), so description does not need to add param info. Baseline 4 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Description clearly states the tool displays server version and connection info (verb+resource). It is distinct from sibling tools which perform API operations or auth/configuration.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No explicit when-to-use or when-not-to-use guidance. Usage is implied for checking server status before other operations, but alternatives are not discussed.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 9 tool updatesv0.1.0
    • First observedsmaregi_api_delete
    • First observedsmaregi_api_get
    • First observedsmaregi_api_list_paths
    • First observedsmaregi_api_patch
    • First observedsmaregi_api_post
    • First observedsmaregi_api_put
    • First observedsmaregi_auth_status
    • First observedsmaregi_configure
    • First observedsmaregi_server_info

TDQS

A3.6/5.0

Scored across 9 tools

Disambiguation5/5

Each tool has a distinct purpose: HTTP methods (GET, POST, PUT, PATCH, DELETE) are clearly separated, and auxiliary tools (list_paths, auth_status, configure, server_info) handle specific non-API operations with no overlap.

Naming Consistency5/5

All tools use a consistent snake_case pattern with the 'smaregi_' prefix. HTTP method tools follow 'smaregi_api_<method>' and other tools use descriptive names like 'smaregi_auth_status', maintaining a predictable structure.

Tool Count5/5

With 9 tools, the server covers essential API operations (all common HTTP methods) and administrative functions (auth, configuration, info). This count is well-scoped for a general-purpose API wrapper without being bloated or sparse.

Completeness5/5

The tool set fully covers the lifecycle of interacting with a REST API: all CRUD methods (GET, POST, PUT, PATCH, DELETE) are present, plus endpoint discovery (list_paths), authentication status, configuration, and server info. No obvious gaps for the stated purpose.

Maintenance

ActivityInactive
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers

  • F
    license
    Not graded
    quality
    D
    maintenance
    Exposes a curated subset of the Officegest API v2 (22 CRUD tools) for managing clients, sales, and stock to AI clients like Claude Code and Claude Desktop.
    1
    -
  • F
    license
    Not graded
    quality
    B
    maintenance
    Enables AI clients to interact with a point-of-sale public API through 32 MCP tools for managing bills, customers, items, orders, receipts, stock, suppliers, taxes, and webhooks over stdio and HTTP transports.
    -
  • F
    license
    C
    quality
    A
    maintenance
    Enables Claude or any MCP client to query a Toast POS using plain English, with 55 read-only tools covering orders, sales, labor, employees, menus, inventory, customers, and cash.
    55
    -