一个 MCP 服务器，让 Claude 可以查看和控制 Kwikset Halo 家族智能锁（Halo、Halo Keypad、Halo Touch、Halo Select / Select Plus）。
这是对早期 Python 版本的 Node.js 重写，用于避免 Windows 上 Python 特有的设置麻烦（缺少解释器、virtualenv 激活、PATH 别名）。Node.js 没有 aiokwikset（第一个版本所依赖的 Python 库）的精确对等物，因此这个版本直接与 Kwikset 的云 API 通信：使用 AWS Cognito 进行登录，外加一个用于 homes/devices/lock/unlock 的小型 REST API。
API 细节的来源： Kwikset 并不提供官方 API。本服务器使用的 Cognito pool/client ID、API 主机和 REST 路径，均来自已发布、采用 Apache-2.0 许可的 homebridge-kwikset-halo 源代码（一个社区 Homebridge 插件，适用于这些锁），该插件又转而感谢 aiokwikset 首先记录这些 API。具体细节请看 src/const.js 和 src/cognito.js 中的注释。本服务器不受 Kwikset 官方支持；如果他们改了服务端，可能会失效。
测试状态： 该服务器中的每一部分逻辑——Cognito 登录流程（包括两步手机验证挑战）、令牌刷新和持久化、REST 字段映射、unlock_door 的确认保护，以及每个 MCP 工具的端到端行为——都已用模拟 AWS Cognito、Kwikset REST API 和 MCP SDK 的手写 mock 进行测试，并且全部通过。此处无法测试的是调用真实的 Kwikset 服务，因为这需要一个真实账户和一把实体锁。把你第一次调用 list_locks 当作真正的冒烟测试——如果它彻底失败（不只是某个字段显示 null），那么 pool/host 常量可能已过时；如果某个工具返回 null，请运行 debug_raw_devices 查看真实字段名，并与 src/kwikset-client.js 对照。
你的 Kwikset 密码绝不应经过 LLM 对话。因此，身份验证只需在普通终端中通过 auth-setup.js 执行一次，并且它只在本地保存生成的会话令牌（绝不保存密码）。MCP 服务器会在每次连接时读取并静默刷新这些令牌——它绝不向 Claude 请求你的密码，也不借助 Claude 向你索要密码。
Related MCP server: Home Assistant MCP Server
安装 Node.js（18+），如果还没有安装：nodejs.org —— 获取 LTS 安装程序。用以下命令验证：
node --version安装依赖，请在此文件夹内运行：
npm install登录一次。 凭据可以按三种方式提供，按以下顺序检查：
# 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 通过短信发送给你的验证码（或者直接用 --mfa-code 或 $KWIKSET_MFA_CODE 提前传入）。这会写入 ~/.kwikset-mcp/tokens.json（仅文件所有者可读/写），并且此步骤之后绝不会再使用你的密码。
让 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 路径中使用双反斜杠，例如 "C:\Users\you\kwikset-mcp\src\server.js"。
然后重启 Claude 客户端，让它启用新的服务器。
试一试。 问 Claude 类似“列出我的 Kwikset 门锁”或“前门锁上了吗？”的问题——它应当调用 list_locks / get_lock_status。解锁需要你明确要求，因为 unlock_door 只有在使用 confirm=true 时才执行操作，而 Claude 只会在你明确要求解除某扇门的锁时才会这样做。
Tool | Description |
| 账号上的所有锁，包含状态、电池电量和所在 home |
| 单个锁的状态 / 电池 / 型号 / 序列号 |
| 锁门 |
| 开门锁，需要 |
| 诊断：来自 Kwkiset API 的原始、未处理的 home/device 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
└── .gitignoreDiagnostic 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.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
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.
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.
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.
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.
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.
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 the current status (locked/unlocked/jammed), battery level, and model/serial for one lock. Get device_id from list_locks first.
| Name | Required | Description | Default |
|---|---|---|---|
| device_id | Yes | A lock's device_id, from list_locks |
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.
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.
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.
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.
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.
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 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.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
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.
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.
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.
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.
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.
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 a Kwikset door. Get device_id from list_locks first.
| Name | Required | Description | Default |
|---|---|---|---|
| device_id | Yes | A lock's device_id, from list_locks |
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.
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.
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.
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.
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.
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 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.
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | No | Must be true to actually unlock the door. | |
| device_id | Yes | A lock's device_id, from list_locks |
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.
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.
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.
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.
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.
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.
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
v0.1.0debug_raw_devicesget_lock_statuslist_lockslock_doorunlock_doorScored across 5 tools
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.
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.
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.
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.
Control your Tesla from your AI assistant - climate, charging, access, and security.
Connect Claude to your Platform7n workspaces — chat, links, and tasks. One-click OAuth.
WHOOP recovery, strain, sleep and workouts in Claude via official WHOOP OAuth. Free, open source.
Run UX research from Claude — create card sort studies, list studies, pull headline stats.
