Skip to main content
Glama

kwikset-mcp

Kwikset Haloファミリーのスマートロック(Halo、Halo Keypad、Halo Touch、Halo Select / Select Plus)をClaudeが確認・制御できるようにするMCPサーバーです。

これは以前のPython版を Node.jsで書き直した ものです。Windowsで発生するPython固有のセットアップ上の面倒(インタープリター未設定、virtualenvの有効化、PATHエイリアス)を避けるために移行しました。最初のバージョンが依存していたaiokwikset(Pythonライブラリ)に相当するNode.jsのライブラリは存在しないため、このバージョンはKwiksetのクラウドAPIと直接通信します。ログインにはAWS Cognito、ホーム/デバイスの一覧とロック/ロック解除には小さなREST APIを使用します。

APIの詳細の入手元: Kwiksetは公式APIを公開していません。このサーバーが使用するCognitoプール/クライアントID、APIホスト、RESTパスは、同じロックに対応するコミュニティ製Homebridgeプラグインであるhomebridge-kwikset-haloのApache-2.0ライセンスで公開されたソースから抽出したものです。このプラグインは、aiokwiksetがそれらの情報を最初に文書化したことをクレジットしています。詳細はsrc/const.jsとsrc/cognito.jsのコメントを参照してください。これはKwiksetが公式にサポートするものではなく、サーバー側の仕様変更により動作しなくなる可能性があります。

テスト状況: このサーバーのロジックのすべて(2段階の電話番号確認チャレンジを含むCognitionログインフロー、トークンのリフレッシュと永続化、RESTのフィールドマッピング、unlock_doorの確認ガード、すべてのMCPツールのエンドツーエンド)は、AWS Cognito、KwiksetのREST API、MCP SDKの代わりとなる手書きのモックを使って検証し、すべて合格しています。ここでテストできなかったのは、実際のKwiksetサービスを呼び出すことです。実際のアカウントと物理的なロックが必要だからです。最初のlist_locks呼び出しを実際のスモークテストとして扱ってください。それが完全に失敗した場合(1つのフィールドがnullになるだけの場合ではなく)は、プール/ホストの定数が古くなっている可能性があります。ツールがnullを返す場合は、debug_raw_devicesを実行して実際のフィールド名を確認し、src/kwikset-client.jsと比較してください。

なぜログインが別ステップなのか

KwiksetのパスワードをLLMの会話に通すべきではありません。そのため認証は、プレーンなターミナルでauth-setup.jsを使って一度だけ行い、結果のセッショントークンのみをローカルに保存します(パスワードは保存しません)。MCPサーバーは接続のたびにそのトークンを読み取り、自動的にリフレッシュします。Claudeにも、Claude経由であなたにも、パスワードを尋ねることはありません。

Related MCP server: Home Assistant MCP Server

セットアップ

  1. Node.js(18以上)をインストールします。まだ入っていない場合はNode.jsからLTS版を取得してください。確認コマンドは次のとおりです:

    node --version
  2. 依存関係をインストールします。このフォルダ内で:

    npm install
  3. 一度だけログインします。 認証情報は3つの方法で指定でき、次の順序でチェックされます:

    # 1. CLI flags (any OS/shell)
    node auth-setup.js --email you@example.com --password "hunter2"
    # 2. Environment variables (preferred over the flag above - a
    #    command-line password is visible to other processes/users on the
    #    machine and lands in shell history)
    
    # macOS / Linux
    KWIKSET_EMAIL=you@example.com KWIKSET_PASSWORD='hunter2' node auth-setup.js
    # Windows PowerShell
    $env:KWIKSET_EMAIL = "you@example.com"
    $env:KWIKSET_PASSWORD = "hunter2"
    node auth-setup.js
    # 3. Interactive prompt (any OS/shell; default if nothing else is given)
    node auth-setup.js

    アカウントで電話番号確認が必要な場合は、KwiksetからSMSで送られてくるコードを求められます(または、前もってで 指定することもできます)。これにより~/.kwikset-mcp/tokens.jsonが作成されます(所有者のみ読み書き可能)。このステップ以降、パスワードは再び使用されません。

  4. Claudeをサーバーに接続します。

    Claude Codeの場合は、このプロジェクトディレクトリから:

    # macOS / Linux
    claude mcp add kwikset -- node "$(pwd)/src/server.js"
    # Windows PowerShell
    claude mcp add kwikset -- node "$PWD\src\server.js"

    Claude Desktopの場合は、claude_desktop_config.json(Settings → Developer → Edit Config)にこれを追加し、このフォルダのsrc/server.jsへの絶対パスに置き換えてください:

    {
      "mcpServers": {
        "kwikset": {
          "command": "node",
          "args": ["/absolute/path/to/kwikset-mcp/src/server.js"]
        }
      }
    }

    Windowsでは、JSONパス内ではdouble backslashを使用してください。例: "C:\\Users\\you\\kwikset-mcp\\src\\server.js" 。

    その後、Claudeクライアントを再起動して新しいサーバーを読み込ませてください。

  5. 試してみます。 Claudeに「Kwiksetのロックを一覧表示して」とか「玄関のドアはロックされていますか?」と尋ねてみてください。list_locks / を呼ぶはずです。ロック解除には明示的な要求が必要です。unlock_doorはconfirm=trueで呼び出されない限り動作を拒否します。Claudeは、そのドアのロックを解除するとはっきり頼んだ場合にのみconfirm=trueを渡します。

利用できるツール

ツール

説明

list_locks

アカウント上のすべてのロック、ステータス、バッテリー残量(%)、ホーム

get_lock_status(device_id)

1つのロックのステータス/バッテリー/モデル/シリアル

lock_door(device_id)

ドアをロックする

unlock_door(device_id, confirm)

ドアのロックを解除する(confirm=true 必須)。

debug_raw_devices

診断: KwiksetのAPIから返された未加工のホーム/デバイスJSON

再認証

トークンが期限切れで自動リフレッシュできない場合(Kwiksetのパスワード変更、2FAのリセットなど)、ツール呼び出しはauth_requiredエラーと手順を返します。その場合はnode auth-setup.jsを再実行してください。

ファイル

kwikset-mcp/
├── auth-setup.js           # run once, by hand, to log in
├── src/
│   ├── const.js             # Cognito pool/client IDs, API host (see caveats above)
│   ├── auth.js               # local token file read/write
│   ├── cognito.js            # AWS Cognito login/refresh (amazon-cognito-identity-js)
│   ├── kwikset-client.js     # REST calls: homes, devices, lock/unlock
│   └── server.js             # MCP server + tool definitions
├── package.json
└── .gitignore

Available Tools

5 tools
debug_raw_devicesA

Diagnostic tool: dumps the raw, unprocessed home/device JSON straight from Kwikset's API. Use this only when another tool returns null fields (name/status/battery, etc) - that means Kwikset renamed a field this server looks for, and this shows the real field names.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

A4.7/5.0
Behavior4/5

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

With no annotations provided, the description carries the full disclosure burden. It clearly states this is a diagnostic read-only dump and explains the failure mode it addresses. It doesn't explicitly state side effects or caveats, but 'dumps' combined with 'Diagnostic tool' implies no mutation, and the scope is well defined.

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 exactly two sentences, with the most essential fact ('Diagnostic tool') front-loaded. Every clause earns its place: the source of data, the triggering condition, and the reason for the null-field symptom. No filler or repetition exists.

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

Completeness5/5

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

The description fully covers what an agent needs: when to invoke this tool, what it returns, and why the output matters. No parameters or output schema are required, and the diagnostic purpose is unlikely to require further detail about return values or error handling for correct selection and invocation.

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 tool has zero parameters and a 100% schema description coverage (vacuously, since the schema is empty). The description explains the nature of the output ('raw, unprocessed... JSON') and the diagnostic trigger, which is sufficient because no parameter guidance is needed.

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 states a specific action ('dumps the raw, unprocessed home/device JSON') and a clear resource ('straight from Kwikset's API'). It identifies itself as a 'Diagnostic tool,' which immediately distinguishes it from the sibling commands that perform listing, status, and locking actions.

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

Usage Guidelines5/5

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

The description gives an explicit condition for when to use it: 'Use this only when another tool returns null fields.' It also explains the reasoning (Kwikset renamed a field) and the expected value (shows real field names), leaving no ambiguity about when to choose this tool over siblings.

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

get_lock_statusA

Get the current status (locked/unlocked/jammed), battery level, and model/serial for one lock. Get device_id from list_locks first.

ParametersJSON Schema
NameRequiredDescriptionDefault
device_idYesA lock's device_id, from list_locks

TDQS

A4.2/5.0
Behavior3/5

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

With no annotations, the description carries the disclosure burden. It indicates a read-only retrieve operation by the word 'Get' and lists the data returned, but it does not explicitly state side-effect-free behavior, failure/error behavior for a bad device_id, or whether status is live vs cached.

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?

Two short sentences contain only useful information: what the tool returns and the required prerequisite. The action and scope are 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 single-parameter read tool with no output schema, the description covers what will be returned and how to get the parameter. It omits edge-case behavior, but the essential calling context is present.

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?

Schema coverage is 100%, giving baseline 3. The description adds value beyond the schema by telling the agent where to obtain device_id and that it must be obtained first from list_locks.

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 starts with a specific verb ('Get'), names the exact resource ('current status ... for one lock'), and enumerates the returned fields (status, battery level, model/serial). This clearly differentiates it from sibling tools like list_locks (listing) and lock_door/unlock_door (actuation).

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

Usage Guidelines4/5

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

The description gives a clear prerequisite and data source: 'Get device_id from list_locks first.' It does not explicitly say when not to use this tool, but the operation is unique among the siblings, so the workflow instruction is the main needed guidance.

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

list_locksA

List every Kwikset lock on the account, with its current status, battery percentage, and the home it belongs to. Call this first to find a lock's device_id before locking/unlocking/checking it.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

A4.6/5.0
Behavior4/5

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

No annotations are provided, so the description must disclose behavior. It clearly states what the tool returns (locks with status, battery, and home) and implies that the device_id is obtainable from the result, which is essential for subsequent operations. It does not explicitly mention side effects (likely read-only) or edge cases, but for a simple listing tool this is sufficient.

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 two concise sentences, with the core purpose and returned content front-loaded and the usage guidance provided second. There is no wasted wording or off-topic detail.

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?

The description adequately covers what the tool does, what it returns, and when to use it relative to siblings. It does not mention pagination or ordering, but given the simple nature of the tool and absence of parameters or output schema, this is a minor gap and does not hinder correct invocation.

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 tool has zero parameters, so no parameter documentation is needed. The baseline of 4 for zero-parameter tools applies because there is nothing to explain, and the description does not omit any required 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 uses a specific verb ('List') and a specific resource ('every Kwikset lock on the account'), and enumerates the returned fields (status, battery, home). This clearly distinguishes it from sibling tools that target individual locks (lock_door, unlock_door, get_lock_status).

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

Usage Guidelines5/5

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

The description explicitly states when to use this tool: 'Call this first to find a lock's device_id before locking/unlocking/checking it.' This gives a direct and clear usage directive that routes the agent to this tool before the sibling operations, and implies when not to use it (after you have the device_id).

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

lock_doorA

Lock a Kwikset door. Get device_id from list_locks first.

ParametersJSON Schema
NameRequiredDescriptionDefault
device_idYesA lock's device_id, from list_locks

TDQS

A3.7/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 the full burden for behavioral disclosure. It states the action but does not mention side effects beyond locking, required permissions, failure modes, idempotency, or what response to expect.

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?

Two tight sentences front-load the action and then give the essential prerequisite. There is no filler or redundant wording.

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?

The tool is simple with one well-documented parameter and a clear action, so the description is minimally viable. However, with no annotations and no output schema, it leaves return/error behavior and side-effect expectations unexplained.

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% and the schema already says device_id comes from list_locks. The description repeats that prerequisite but adds no additional parameter semantics beyond what the schema provides, so the baseline score applies.

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 uses a specific verb and resource ('Lock a Kwikset door') and the prerequisite ('Get device_id from list_locks first') further clarifies its role. It is clearly distinct from unlock_door and list_locks without needing to read their schemas.

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

Usage Guidelines4/5

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

The description gives a clear usage context by instructing the agent to obtain device_id from list_locks first. It does not explicitly mention when not to use it or name unlock_door as the alternative, but the command's action is self-explanatory enough for basic routing.

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

unlock_doorA

Unlock a Kwikset door. This is a physical-security-sensitive action - only call this after the user has explicitly asked to unlock this specific door, and pass confirm=true. Calling with confirm=false (the default) is a no-op that returns a reminder instead of unlocking.

ParametersJSON Schema
NameRequiredDescriptionDefault
confirmNoMust be true to actually unlock the door.
device_idYesA lock's device_id, from list_locks

TDQS

A4.9/5.0
Behavior5/5

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

With no annotations provided, the description carries full responsibility, and it delivers. It flags the action as physical-security-sensitive, states the confirmation requirement, and discloses that calling with confirm=false is a no-op that returns a reminder instead of unlocking.

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 two sentences with no filler. It front-loads the core action, then packs the security warning, caller precondition, and confirmation behavior into compact, high-value language.

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

Completeness5/5

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

For a simple two-parameter physical-security action with no output schema, the description covers everything needed to invoke it correctly: the requirement for explicit user consent, the needed confirmation flag, and the no-op fallback. Nothing critical is missing.

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?

Schema coverage is 100%, so parameters are already documented. The description adds meaningful behavioral context beyond the schema by specifying that confirm=true is required and that false leads to a no-op reminder, which is not fully captured in the schema alone.

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 states a specific verb and resource: 'Unlock a Kwikset door.' It is immediately distinguishable from sibling tools like lock_door and list_locks, leaving no ambiguity about the tool's function.

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

Usage Guidelines5/5

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

The description gives explicit when-to-use guidance: only after the user has explicitly asked to unlock this specific door. It also requires confirm=true and explains that confirm=false is a deliberate no-op, providing clear behavior boundaries.

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. 5 tool updatesv0.1.0
    • First observeddebug_raw_devices
    • First observedget_lock_status
    • First observedlist_locks
    • First observedlock_door
    • First observedunlock_door

TDQS

A4.4/5.0

Scored across 5 tools

Disambiguation5/5

Each tool has a crystal-clear, non-overlapping purpose: listing all locks, fetching one lock's status, locking, unlocking, and debugging raw API data. No two tools could be confused for each other.

Naming Consistency5/5

All tools follow a consistent verb_noun pattern (list_locks, get_lock_status, lock_door, unlock_door, debug_raw_devices). The naming is uniform and predictable.

Tool Count5/5

Five tools is perfectly scoped for a smart-lock management server. Each tool addresses an essential core function, with no redundancy and no obvious missing high-level operation.

Completeness5/5

The core lifecycle for lock management is fully covered: list, get status, lock, and unlock. The debug tool covers a diagnostic edge case, making the surface feel complete for its stated purpose.

Maintenance

ActivityMaintained
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers

  • F
    license
    Not graded
    quality
    C
    maintenance
    Enables control of smart locks through the Seam API, allowing users to lock/unlock doors, check status, and manage access codes across 100+ supported lock brands. Supports comprehensive access code management including temporary codes and multi-lock operations.
    -
  • A
    license
    Not graded
    quality
    D
    maintenance
    Enables Claude Desktop to read and control Home Assistant devices via natural language, with configurable safety restrictions on sensitive actions.
    2
    MIT
  • A
    license
    Not graded
    quality
    B
    maintenance
    Enables Claude to control PetLibro RFID pet feeders and water fountains by checking food/battery/water status, dispensing food by the cup, and force-opening feeder lids via the PetLibro cloud API.
    GPL 3.0
  • F
    license
    Not graded
    quality
    C
    maintenance
    Enables checking and controlling Kwikset Halo-family smart locks, including listing locks, viewing status and battery, and locking/unlocking doors, with token-based authentication kept outside the LLM conversation.
    1
    -