kwikset-mcp
kwikset-mcp
Un servidor MCP que permite a Claude consultar y controlar las cerraduras inteligentes de Kwikset de la familia Halo (Halo, Halo Keypad, Halo Touch, Halo Select / Select Plus).
Esta es una reescritura en Node.js de una versión anterior en Python, elegida para evitar las fricciones de configuración específicas de Python en Windows (intérprete ausente, activación de virtualenv, alias de PATH). Node no tiene un equivalente exacto de aiokwikset (la librería Python de la que dependía la primera versión), así que esta versión habla directamente con la API en la nube de Kwikset: AWS Cognito para el inicio de sesión y una pequeña API REST para casas/dispositivos/bloquear/desbloquear.
De dónde salen los detalles de la API: Kwikset no publica una API oficial. Los IDs de pool/cliente de Cognito, el host de la API y las rutas REST que usa este servidor se extrajeron del código fuente publicado, con licencia Apache-2.0, de homebridge-kwikset-halo (un plugin comunitario de Homebridge para estas mismas cerraduras), que a su vez da crédito a aiokwikset por haberlos documentado por primera vez. Consulta los comentarios de src/const.js y src/cognito.js para más detalles. Esto no cuenta con soporte oficial de Kwikset y podría romperse si cambian algo en el lado del servidor.
Estado de las pruebas: toda la lógica de este servidor — el flujo de inicio de sesión de Cognito (incluido el desafío de verificación telefónica en dos pasos), la renovación de tokens, la persistencia de tokens, el mapeo de campos de la API REST, la protección de confirmación de unlock_door y todas las herramientas MCP de principio a fin — se probó contra simulacros escritos a mano que representan a AWS Cognito, la API REST de Kwikset y el SDK MCP, y todo pasa. Lo que no se ha podido probar aquí es llamar al servicio real de Kwikset, porque se necesita una cuenta real y una cerradura física. Considera tu primera llamada a list_locks como la prueba de humo real; si falla por completo (no solo un campo que muestre null), es posible que las constantes de pool/host estén desactualizadas; si una herramienta devuelve null, ejecuta debug_raw_devices para ver los nombres de campo reales y compáralos con src/kwikset-client.js.
Por qué el inicio de sesión es un paso aparte
Tu contraseña de Kwikset nunca debería pasar por una conversación con un LLM. Por eso la autenticación ocurre una sola vez, en un terminal normal, mediante auth-setup.js, que guarda localmente solo los tokens resultantes (nunca la contraseña). El servidor MCP lee y actualiza silenciosamente esos tokens en cada conexión — nunca le pide tu contraseña a Claude, ni a ti a través de Claude.
Related MCP server: Home Assistant MCP Server
Configuración
Instala Node.js (18+) si no lo tienes: nodejs.org — descarga el instalador LTS. Verifícalo con:
node --versionInstala las dependencias, desde dentro de esta carpeta:
npm installInicia sesión una vez. Las credenciales se pueden dar de tres maneras, comprobadas en este orden:
# 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.jsSi tu cuenta requiere verificación telefónica, se te pedirá el código que Kwikset te envíe por texto (o puedes pasarlo de antemano con
--mfa-code/$KWIKSET_MFA_CODE). Esto escribe~/.kwikset-mcp/tokens.json(solo lectura/escritura del propietario) y no vuelve a tocar tu contraseña después de este paso.Configura Claude para apuntar al servidor.
Para Claude Code, desde este directorio de proyecto:
# macOS / Linux claude mcp add kwikset -- node "$(pwd)/src/server.js"# Windows PowerShell claude mcp add kwikset -- node "$PWD\src\server.js"Para Claude Desktop, añade esto a tu
claude_desktop_config.json(Ajustes → Desarrollador → Editar configuración), sustituyendo la ruta absoluta por elsrc/server.jsde esta carpeta:{ "mcpServers": { "kwikset": { "command": "node", "args": ["/absolute/path/to/kwikset-mcp/src/server.js"] } } }En Windows, usa doble barra invertida en la ruta JSON, por ejemplo
"C:\\Users\\you\\kwiket-mcp\\src\\server.js".Después reinicia el cliente de Claude para que cargue el nuevo servidor.
Pruébalo. Pide a Claude algo como "lista" o "la puerta principal está bloqueada" — debería llamar a
list_locks/get_lock_status. Desbloquear requiere una petición explícita, porqueunlock_doorno actúa salvo que se llame conconfirm=true, y Claude solo hará eso si le pides claramente que desbloquee esa puerta.
Herramientas expuestas
| Herramienta | Descripción |
| --------------------------------- --------------------------------------- |
| list_locks | Todas las cerraduras de la cuenta, con estado, % de batería y casa |
| get_lock_status(device_id) | Estado, batería, modelo y número de serie de una cerradura |
| lock_door(device_id) | Bloquear una puerta |
| unlock_door(device_id, confirm) | Desbloquear una puerta (requiere confirm=true) |
| debug_raw_devices | Diagnóstico: JSON crudo, sin procesar, de casas/dispositivos de la API de Kwikset |
Reautenticación
Si los tokens caducan y no se pueden actualizar en silencio (por ejemplo, se cambió la contraseña de Kwikset o se restableció la 2FA), las llamadas a las herramientas devolverán un error auth_required con instrucciones — solo tienes que volver a ejecutar node auth-setup.js.
Archivos
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
└── .gitignoreAvailable Tools
5 toolsdebug_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.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
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_lock_statusA
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 |
TDQS
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_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.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
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_doorA
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 |
TDQS
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_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.
| 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 |
TDQS
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.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
5 tool updates
v0.1.0- First observed
debug_raw_devices - First observed
get_lock_status - First observed
list_locks - First observed
lock_door - First observed
unlock_door
TDQS
Scored 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.
Maintenance
Related MCP Connectors
- mytesla.ioOAuthio.mytesla
Control your Tesla from your AI assistant - climate, charging, access, and security.
- platform7nOAuthtech.p7n
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.
Related MCP Servers
- FlicenseNot gradedqualityCmaintenanceEnables 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.-
- AlicenseNot gradedqualityDmaintenanceEnables Claude Desktop to read and control Home Assistant devices via natural language, with configurable safety restrictions on sensitive actions.2MIT
- AlicenseNot gradedqualityBmaintenanceEnables 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
- FlicenseNot gradedqualityCmaintenanceEnables 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-