@nightsquawktech/tacticalrmm-mcp-server 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (88) hide show
  1. package/COMMERCIAL.md +35 -0
  2. package/LICENSE +661 -0
  3. package/README.md +79 -0
  4. package/dist/constants.d.ts +10 -0
  5. package/dist/constants.d.ts.map +1 -0
  6. package/dist/constants.js +10 -0
  7. package/dist/constants.js.map +1 -0
  8. package/dist/index.d.ts +3 -0
  9. package/dist/index.d.ts.map +1 -0
  10. package/dist/index.js +24 -0
  11. package/dist/index.js.map +1 -0
  12. package/dist/schemas/agents.d.ts +39 -0
  13. package/dist/schemas/agents.d.ts.map +1 -0
  14. package/dist/schemas/agents.js +37 -0
  15. package/dist/schemas/agents.js.map +1 -0
  16. package/dist/schemas/clients.d.ts +16 -0
  17. package/dist/schemas/clients.d.ts.map +1 -0
  18. package/dist/schemas/clients.js +10 -0
  19. package/dist/schemas/clients.js.map +1 -0
  20. package/dist/schemas/common.d.ts +5 -0
  21. package/dist/schemas/common.d.ts.map +1 -0
  22. package/dist/schemas/common.js +19 -0
  23. package/dist/schemas/common.js.map +1 -0
  24. package/dist/schemas/resources.d.ts +76 -0
  25. package/dist/schemas/resources.d.ts.map +1 -0
  26. package/dist/schemas/resources.js +37 -0
  27. package/dist/schemas/resources.js.map +1 -0
  28. package/dist/schemas/server.d.ts +10 -0
  29. package/dist/schemas/server.d.ts.map +1 -0
  30. package/dist/schemas/server.js +8 -0
  31. package/dist/schemas/server.js.map +1 -0
  32. package/dist/services/config.d.ts +3 -0
  33. package/dist/services/config.d.ts.map +1 -0
  34. package/dist/services/config.js +22 -0
  35. package/dist/services/config.js.map +1 -0
  36. package/dist/services/errors.d.ts +2 -0
  37. package/dist/services/errors.d.ts.map +1 -0
  38. package/dist/services/errors.js +41 -0
  39. package/dist/services/errors.js.map +1 -0
  40. package/dist/services/tacticalrmm-client.d.ts +10 -0
  41. package/dist/services/tacticalrmm-client.d.ts.map +1 -0
  42. package/dist/services/tacticalrmm-client.js +37 -0
  43. package/dist/services/tacticalrmm-client.js.map +1 -0
  44. package/dist/tools/agents.d.ts +4 -0
  45. package/dist/tools/agents.d.ts.map +1 -0
  46. package/dist/tools/agents.js +97 -0
  47. package/dist/tools/agents.js.map +1 -0
  48. package/dist/tools/automation.d.ts +4 -0
  49. package/dist/tools/automation.d.ts.map +1 -0
  50. package/dist/tools/automation.js +41 -0
  51. package/dist/tools/automation.js.map +1 -0
  52. package/dist/tools/clients.d.ts +4 -0
  53. package/dist/tools/clients.d.ts.map +1 -0
  54. package/dist/tools/clients.js +34 -0
  55. package/dist/tools/clients.js.map +1 -0
  56. package/dist/tools/format.d.ts +6 -0
  57. package/dist/tools/format.d.ts.map +1 -0
  58. package/dist/tools/format.js +37 -0
  59. package/dist/tools/format.js.map +1 -0
  60. package/dist/tools/index.d.ts +4 -0
  61. package/dist/tools/index.d.ts.map +1 -0
  62. package/dist/tools/index.js +17 -0
  63. package/dist/tools/index.js.map +1 -0
  64. package/dist/tools/inventory.d.ts +4 -0
  65. package/dist/tools/inventory.d.ts.map +1 -0
  66. package/dist/tools/inventory.js +32 -0
  67. package/dist/tools/inventory.js.map +1 -0
  68. package/dist/tools/logs.d.ts +4 -0
  69. package/dist/tools/logs.d.ts.map +1 -0
  70. package/dist/tools/logs.js +91 -0
  71. package/dist/tools/logs.js.map +1 -0
  72. package/dist/tools/monitoring.d.ts +4 -0
  73. package/dist/tools/monitoring.d.ts.map +1 -0
  74. package/dist/tools/monitoring.js +70 -0
  75. package/dist/tools/monitoring.js.map +1 -0
  76. package/dist/tools/read-tools.d.ts +20 -0
  77. package/dist/tools/read-tools.d.ts.map +1 -0
  78. package/dist/tools/read-tools.js +51 -0
  79. package/dist/tools/read-tools.js.map +1 -0
  80. package/dist/tools/server.d.ts +4 -0
  81. package/dist/tools/server.d.ts.map +1 -0
  82. package/dist/tools/server.js +42 -0
  83. package/dist/tools/server.js.map +1 -0
  84. package/dist/types.d.ts +26 -0
  85. package/dist/types.d.ts.map +1 -0
  86. package/dist/types.js +2 -0
  87. package/dist/types.js.map +1 -0
  88. package/package.json +47 -0
@@ -0,0 +1,51 @@
1
+ import { formatApiError } from "../services/errors.js";
2
+ import { formatResponse, makeToolResponse, paginate, summarizeRecord } from "./format.js";
3
+ export function registerCollectionReadTool(server, client, options) {
4
+ server.registerTool(options.name, {
5
+ title: options.title,
6
+ description: options.description,
7
+ inputSchema: options.inputSchema,
8
+ annotations: {
9
+ readOnlyHint: true,
10
+ destructiveHint: false,
11
+ idempotentHint: true,
12
+ openWorldHint: true
13
+ }
14
+ }, async (params) => {
15
+ try {
16
+ const paging = params;
17
+ const raw = options.method === "query"
18
+ ? await client.query(options.path(params), options.body?.(params))
19
+ : await client.get(options.path(params), options.query?.(params));
20
+ const items = extractItems(raw);
21
+ const data = paginate(items, paging.limit, paging.offset);
22
+ const markdown = [
23
+ `# ${options.heading}`,
24
+ "",
25
+ `Showing ${data.count} of ${data.total} records.`,
26
+ "",
27
+ ...data.items.map((item) => `- ${summarizeRecord(item, options.preferredFields)}`)
28
+ ].join("\n");
29
+ return makeToolResponse(data, formatResponse(paging.response_format, data, markdown));
30
+ }
31
+ catch (error) {
32
+ const data = { error: formatApiError(error) };
33
+ return makeToolResponse(data, data.error, true);
34
+ }
35
+ });
36
+ }
37
+ export function extractItems(raw) {
38
+ if (Array.isArray(raw)) {
39
+ return raw;
40
+ }
41
+ if (raw && typeof raw === "object") {
42
+ const source = raw;
43
+ for (const key of ["results", "items", "data", "rows"]) {
44
+ if (Array.isArray(source[key])) {
45
+ return source[key];
46
+ }
47
+ }
48
+ }
49
+ return raw === undefined || raw === null ? [] : [raw];
50
+ }
51
+ //# sourceMappingURL=read-tools.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"read-tools.js","sourceRoot":"","sources":["../../src/tools/read-tools.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAuB1F,MAAM,UAAU,0BAA0B,CACxC,MAAiB,EACjB,MAAyB,EACzB,OAA8B;IAE9B,MAAM,CAAC,YAAY,CACjB,OAAO,CAAC,IAAI,EACZ;QACE,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,WAAW,EAAE;YACX,YAAY,EAAE,IAAI;YAClB,eAAe,EAAE,KAAK;YACtB,cAAc,EAAE,IAAI;YACpB,aAAa,EAAE,IAAI;SACpB;KACF,EACD,KAAK,EAAE,MAAkB,EAAE,EAAE;QAC3B,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAA0B,CAAC;YAC1C,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,KAAK,OAAO;gBACpC,CAAC,CAAC,MAAM,MAAM,CAAC,KAAK,CAAU,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC;gBAC3E,CAAC,CAAC,MAAM,MAAM,CAAC,GAAG,CAAU,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;YAC7E,MAAM,KAAK,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;YAChC,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;YAC1D,MAAM,QAAQ,GAAG;gBACf,KAAK,OAAO,CAAC,OAAO,EAAE;gBACtB,EAAE;gBACF,WAAW,IAAI,CAAC,KAAK,OAAO,IAAI,CAAC,KAAK,WAAW;gBACjD,EAAE;gBACF,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,eAAe,CAAC,EAAE,CAAC;aACnF,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEb,OAAO,gBAAgB,CAAC,IAAI,EAAE,cAAc,CAAC,MAAM,CAAC,eAAe,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;QACxF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,GAAG,EAAE,KAAK,EAAE,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9C,OAAO,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAClD,CAAC;IACH,CAAC,CACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,GAAY;IACvC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACvB,OAAO,GAAG,CAAC;IACb,CAAC;IAED,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QACnC,MAAM,MAAM,GAAG,GAA8B,CAAC;QAC9C,KAAK,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;YACvD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBAC/B,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;YACrB,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AACxD,CAAC"}
@@ -0,0 +1,4 @@
1
+ import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
2
+ import type { TacticalRmmClient } from "../services/tacticalrmm-client.js";
3
+ export declare function registerServerTools(server: McpServer, client: TacticalRmmClient): void;
4
+ //# sourceMappingURL=server.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../src/tools/server.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACzE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AAK3E,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,iBAAiB,GAAG,IAAI,CAwCtF"}
@@ -0,0 +1,42 @@
1
+ import { formatApiError } from "../services/errors.js";
2
+ import { ServerInfoSchema } from "../schemas/server.js";
3
+ import { formatResponse, makeToolResponse } from "./format.js";
4
+ export function registerServerTools(server, client) {
5
+ server.registerTool("tacticalrmm_get_server_info", {
6
+ title: "Get TacticalRMM Server Info",
7
+ description: "Read TacticalRMM server version and dashboard information from /core/version/ and /core/dashinfo/.",
8
+ inputSchema: ServerInfoSchema.shape,
9
+ annotations: {
10
+ readOnlyHint: true,
11
+ destructiveHint: false,
12
+ idempotentHint: true,
13
+ openWorldHint: true
14
+ }
15
+ }, async ({ response_format }) => {
16
+ try {
17
+ const [version, dashboard] = await Promise.allSettled([
18
+ client.get("/core/version/"),
19
+ client.get("/core/dashinfo/")
20
+ ]);
21
+ const data = {
22
+ version: version.status === "fulfilled" ? version.value : { error: formatApiError(version.reason) },
23
+ dashboard: dashboard.status === "fulfilled" ? dashboard.value : { error: formatApiError(dashboard.reason) }
24
+ };
25
+ const markdown = [
26
+ "# TacticalRMM Server Info",
27
+ "",
28
+ `- Version: ${formatInline(data.version)}`,
29
+ `- Dashboard: ${formatInline(data.dashboard)}`
30
+ ].join("\n");
31
+ return makeToolResponse(data, formatResponse(response_format, data, markdown));
32
+ }
33
+ catch (error) {
34
+ const data = { error: formatApiError(error) };
35
+ return makeToolResponse(data, data.error, true);
36
+ }
37
+ });
38
+ }
39
+ function formatInline(value) {
40
+ return typeof value === "string" ? value : JSON.stringify(value);
41
+ }
42
+ //# sourceMappingURL=server.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"server.js","sourceRoot":"","sources":["../../src/tools/server.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAwB,MAAM,sBAAsB,CAAC;AAC9E,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/D,MAAM,UAAU,mBAAmB,CAAC,MAAiB,EAAE,MAAyB;IAC9E,MAAM,CAAC,YAAY,CACjB,6BAA6B,EAC7B;QACE,KAAK,EAAE,6BAA6B;QACpC,WAAW,EAAE,oGAAoG;QACjH,WAAW,EAAE,gBAAgB,CAAC,KAAK;QACnC,WAAW,EAAE;YACX,YAAY,EAAE,IAAI;YAClB,eAAe,EAAE,KAAK;YACtB,cAAc,EAAE,IAAI;YACpB,aAAa,EAAE,IAAI;SACpB;KACF,EACD,KAAK,EAAE,EAAE,eAAe,EAAmB,EAAE,EAAE;QAC7C,IAAI,CAAC;YACH,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC;gBACpD,MAAM,CAAC,GAAG,CAAU,gBAAgB,CAAC;gBACrC,MAAM,CAAC,GAAG,CAAU,iBAAiB,CAAC;aACvC,CAAC,CAAC;YAEH,MAAM,IAAI,GAA4B;gBACpC,OAAO,EAAE,OAAO,CAAC,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;gBACnG,SAAS,EAAE,SAAS,CAAC,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,cAAc,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;aAC5G,CAAC;YAEF,MAAM,QAAQ,GAAG;gBACf,2BAA2B;gBAC3B,EAAE;gBACF,cAAc,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;gBAC1C,gBAAgB,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;aAC/C,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEb,OAAO,gBAAgB,CAAC,IAAI,EAAE,cAAc,CAAC,eAAe,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;QACjF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,GAAG,EAAE,KAAK,EAAE,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9C,OAAO,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAClD,CAAC;IACH,CAAC,CACF,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,KAAc;IAClC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AACnE,CAAC"}
@@ -0,0 +1,26 @@
1
+ export type TacticalRmmMethod = "GET" | "PATCH";
2
+ export type ResponseFormat = "markdown" | "json";
3
+ export interface TacticalRmmConfig {
4
+ baseUrl: string;
5
+ apiKey: string;
6
+ timeoutMs: number;
7
+ }
8
+ export interface PaginatedItems<T> {
9
+ [key: string]: unknown;
10
+ total: number;
11
+ count: number;
12
+ offset: number;
13
+ items: T[];
14
+ has_more: boolean;
15
+ next_offset?: number;
16
+ }
17
+ export interface ToolResponse<T extends Record<string, unknown>> {
18
+ [key: string]: unknown;
19
+ content: Array<{
20
+ type: "text";
21
+ text: string;
22
+ }>;
23
+ structuredContent: T;
24
+ isError?: boolean;
25
+ }
26
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,OAAO,CAAC;AAEhD,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG,MAAM,CAAC;AAEjD,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,cAAc,CAAC,CAAC;IAC/B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,CAAC,EAAE,CAAC;IACX,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAC7D,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IACvB,OAAO,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC/C,iBAAiB,EAAE,CAAC,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB"}
package/dist/types.js ADDED
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}
package/package.json ADDED
@@ -0,0 +1,47 @@
1
+ {
2
+ "name": "@nightsquawktech/tacticalrmm-mcp-server",
3
+ "version": "0.1.0",
4
+ "description": "MCP server for self-hosted TacticalRMM instances.",
5
+ "type": "module",
6
+ "main": "dist/index.js",
7
+ "bin": "./dist/index.js",
8
+ "files": [
9
+ "dist",
10
+ "README.md",
11
+ "LICENSE",
12
+ "COMMERCIAL.md"
13
+ ],
14
+ "scripts": {
15
+ "build": "tsc",
16
+ "start": "node dist/index.js",
17
+ "dev": "tsx src/index.ts",
18
+ "clean": "rimraf dist"
19
+ },
20
+ "engines": {
21
+ "node": ">=20"
22
+ },
23
+ "dependencies": {
24
+ "@modelcontextprotocol/sdk": "^1.26.0",
25
+ "axios": "^1.13.2",
26
+ "zod": "^3.25.0"
27
+ },
28
+ "devDependencies": {
29
+ "@types/node": "^24.0.0",
30
+ "rimraf": "^6.0.1",
31
+ "tsx": "^4.20.0",
32
+ "typescript": "^5.9.0"
33
+ },
34
+ "license": "AGPL-3.0-only",
35
+ "author": "Kevin Reyes (NightSquawk Tech) <hello@nightsquawk.tech>",
36
+ "repository": {
37
+ "type": "git",
38
+ "url": "git+https://github.com/NightSquawk/tacticalrmm-mcp-server.git"
39
+ },
40
+ "homepage": "https://github.com/NightSquawk/tacticalrmm-mcp-server#readme",
41
+ "bugs": {
42
+ "url": "https://github.com/NightSquawk/tacticalrmm-mcp-server/issues"
43
+ },
44
+ "publishConfig": {
45
+ "access": "public"
46
+ }
47
+ }