alex/homeassistant-mcp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

initial commit

Browse Source
This commit is contained in:
Tevon Strand-Brown
2024-12-11 22:31:43 -08:00
parent 140576a9a5
commit 56c34635be
8 changed files with 3733 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored Normal file
View File

@@ -0,0 +1,3 @@
node_modules
dist
.env

39
package.json Normal file
View File

@@ -0,0 +1,39 @@
{
"name": "mcp",
"version": "1.0.0",
"description": "MCP for HASS",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"scripts": {
"build": "tsc",
"test": "jest",
"prepare": "npm run build",
"start": "node dist/index.js",
"dev": "ts-node src/index.ts",
"build:start": "npm run build && npm run start"
},
"author": "Tevon Strand-Brown",
"license": "ISC",
"dependencies": {
"@digital-alchemy/core": "^24.11.4",
"@digital-alchemy/hass": "^24.11.4",
"@modelcontextprotocol/sdk": "^1.0.3",
"dotenv": "^16.4.7",
"litemcp": "^0.7.0",
"zod": "^3.24.1",
"zod-to-json-schema": "^3.24.1"
},
"devDependencies": {
"@digital-alchemy/type-writer": "^24.11.3",
"@types/express": "^5.0.0",
"@types/jest": "^29.5.11",
"@types/node": "^20.11.0",
"@types/socket.io": "^3.0.1",
"jest": "^29.7.0",
"nodemon": "^3.0.2",
"ts-jest": "^29.1.1",
"ts-node": "^10.9.2",
"typescript": "^5.7.2"
},
"type": "module"
}

36
src/.gitignore vendored Normal file
View File

@@ -0,0 +1,36 @@
# Dependencies
node_modules/
yarn.lock
# Build output
dist/
build/
*.tsbuildinfo
# Environment variables
.env
.env.local
.env.*.local
# IDE/Editor
.vscode/
.idea/
*.swp
*.swo
# Logs
logs/
*.log
npm-debug.log*
# Testing
coverage/
# OS generated files
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
ehthumbs.db
Thumbs.db

27
src/hass/index.ts Normal file
View File

@@ -0,0 +1,27 @@
import { CreateApplication, TServiceParams, StringConfig } from "@digital-alchemy/core";
type Environments = "development" | "production" | "test";
import { LIB_HASS } from "@digital-alchemy/hass";
// application
const MY_APP = CreateApplication({
configuration: {
NODE_ENV: {
type: "string",
default: "development",
enum: ["development", "production", "test"],
description: "Code runner addon can set with it's own NODE_ENV",
} satisfies StringConfig<Environments>,
},
services: {},
libraries: [LIB_HASS],
name: 'boilerplate'
});
const hass = await MY_APP.bootstrap()
export async function get_hass() {
return hass;
}

131
src/index.ts Normal file
View File

@@ -0,0 +1,131 @@
import { get_hass } from "./hass/index.js";
import { LiteMCP } from "litemcp";
import { z } from "zod";
import { TAreaId, TFloorId, TRawDomains, TRawEntityIds } from "@digital-alchemy/hass";
import { zodToJsonSchema } from "zod-to-json-schema";
import { ListRequestSchema, AreaSchema, FloorSchema } from "./schemas.js";
const server = new LiteMCP(
"example-server",
"1.0.0",
);
const hass = await get_hass();
server.addTool({
name: "list_domains",
description: "Lists all domains in the home",
parameters: z.object({}),
execute: async () => {
return ["light", "climate", "alarm_control_panel", "cover", "switch", "sensor", "button"];
}
});
server.addTool({
name: "list_areas",
description: "Lists all areas in the home",
parameters: z.object({}),
execute: async () => {
return await areasRequestHandler();
}
});
server.addTool({
name: "list_floors",
description: "Lists all floors in the home",
parameters: z.object({}),
execute: async () => {
return await floorsRequestHandler();
}
});
server.addTool({
name: "get_entity_state",
description: "Gets the state of an entity",
parameters: z.object({
entity_id: z.string()
}),
execute: async (request) => {
return await hass.hass.entity.getCurrentState(request.entity_id as TRawEntityIds);
}
});
server.addTool({
name: "get_entities",
description: "Gets entities, filtered by domain, floor, and area as needed",
parameters: z.object({
domain: z.string().optional(),
floor: z.string().optional(),
area: z.string().optional(),
}),
execute: async (request) => {
if (request.floor) {
return hass.hass.idBy.floor(request.floor as TFloorId, request.domain as TRawDomains || undefined);
}
if (request.area) {
return hass.hass.idBy.area(request.area as TAreaId, request.domain as TRawDomains || undefined);
}
if (request.domain) {
return hass.hass.entity.listEntities(request.domain as TRawDomains);
}
return hass.hass.entity.listEntities();
}
});
server.addTool({
name: "get_entity_state_by_ids",
description: "Gets a list of entities from a list of entity ids. Use this tool when there is more than one entity to get the state of.",
parameters: z.object({
entity_ids: z.array(z.string())
}),
execute: async (request) => {
const entities = request.entity_ids.map(entity_id => hass.hass.entity.getCurrentState(entity_id as TRawEntityIds));
return entities;
}
})
server.addTool({
name: "get_entity_history",
description: "Gets the history of an entity",
parameters: z.object({
entity_id: z.string(),
start_time: z.string(),
end_time: z.string().optional()
}),
execute: async (request) => {
return await hass.hass.entity.history({
end_time: request.end_time ? new Date(request.end_time) : new Date(),
entity_ids: [request.entity_id as TRawEntityIds],
start_time: request.start_time
});
}
})
server.addTool({
name: "get_entity_history_by_ids",
description: "Gets the history of a list of entities",
parameters: z.object({
entity_ids: z.array(z.string()),
start_time: z.string(),
end_time: z.string().optional()
}),
execute: async (request) => {
return await hass.hass.entity.history({
entity_ids: request.entity_ids as TRawEntityIds[],
end_time: request.end_time ? new Date(request.end_time) : new Date(),
start_time: request.start_time
});
}
})
const areasRequestHandler = async () => {
const areas = await hass.hass.area.list()
return areas;
}
const floorsRequestHandler = async () => {
const floors = await hass.hass.floor.list()
return floors;
}
server.start();

82
src/schemas.ts Normal file
View File

@@ -0,0 +1,82 @@
import { z } from "zod";
export const DomainSchema = z.enum(["light", "climate", "alarm_control_panel", "cover", "switch"]);
// Generic list request schema
export const ListRequestSchema = z.object({
domain: DomainSchema,
area: z.string().optional(),
floor: z.string().optional(),
});
// Areas
export const AreaSchema = z.object({
id: z.string(),
name: z.string(),
floor: z.string(),
});
export const FloorSchema = z.object({
id: z.string(),
name: z.string(),
});
export const ListFloorsResponseSchema = z.object({
floors: z.array(FloorSchema),
});
// Alarm
export const AlarmAttributesSchema = z.object({
code_format: z.string().optional(),
changed_by: z.string().optional(),
code_arm_required: z.boolean().optional(),
friendly_name: z.string().optional(),
supported_features: z.number().optional(),
});
export const AlarmSchema = z.object({
entity_id: z.string(),
state: z.string(),
state_attributes: AlarmAttributesSchema,
});
export const ListAlarmsResponseSchema = z.object({
alarms: z.array(AlarmSchema),
});
// Devices
export const DeviceSchema = z.object({
id: z.string(),
name: z.string(),
name_by_user: z.string().optional(),
model: z.string(),
model_id: z.string().nullable(),
manufacturer: z.string(),
area_id: z.string().nullable(),
config_entries: z.array(z.string()),
primary_config_entry: z.string(),
connections: z.array(z.tuple([z.string(), z.string()])),
configuration_url: z.string().nullable(),
disabled_by: z.string().nullable(),
entry_type: z.string().nullable(),
hw_version: z.string().nullable(),
sw_version: z.string().nullable(),
via_device_id: z.string().nullable(),
created_at: z.number(),
modified_at: z.number(),
identifiers: z.array(z.any()),
labels: z.array(z.string()),
serial_number: z.string().optional()
});
export const ListDevicesResponseSchema = z.object({
_meta: z.object({}).optional(),
devices: z.array(DeviceSchema)
});

115
tsconfig.json Normal file
View File

@@ -0,0 +1,115 @@
{
"compilerOptions": {
"paths": {
"@hass/*": ["./src/hass/*"],
"@server/*": ["./src/server/*"]
},
/* Visit https://aka.ms/tsconfig to read more about this file */
/* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
/* Language and Environment */
"target": "ES2018", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
/* Modules */
"module": "node16", /* Specify what module code is generated. */
// "rootDir": "./", /* Specify the root folder within your source files. */
"moduleResolution": "node16", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
// "rewriteRelativeImportExtensions": true, /* Rewrite '.ts', '.tsx', '.mts', and '.cts' file extensions in relative import paths to their JavaScript equivalent in output files. */
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
// "noUncheckedSideEffectImports": true, /* Check side effect imports. */
// "resolveJsonModule": true, /* Enable importing .json files. */
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
"outDir": "./dist/", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
// "isolatedDeclarations": true, /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "strictBuiltinIteratorReturn": true, /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
}
}

3300
yarn.lock Normal file
View File

File diff suppressed because it is too large Load Diff