@get-technology-inc/jamf-docs-mcp-server 0.0.1 → 1.0.0

package/dist/types.d.ts

@@ -0,0 +1,197 @@
+/**
+ * Type definitions for Jamf Docs MCP Server
+ */
+import { ResponseFormat, ProductId, TopicId } from './constants.js';
+/**
+ * Token information for response size management
+ */
+export interface TokenInfo {
+    tokenCount: number;
+    truncated: boolean;
+    maxTokens: number;
+}
+/**
+ * Pagination information for paginated responses
+ */
+export interface PaginationInfo {
+    page: number;
+    pageSize: number;
+    totalPages: number;
+    totalItems: number;
+    hasNext: boolean;
+    hasPrev: boolean;
+}
+/**
+ * Article section information for section filtering
+ */
+export interface ArticleSection {
+    id: string;
+    title: string;
+    level: number;
+    tokenCount: number;
+}
+export interface JamfProduct {
+    id: ProductId;
+    name: string;
+    description: string;
+    urlPattern: string;
+    bundleId: string;
+    latestVersion: string;
+    versions: readonly string[];
+}
+export interface ProductListResponse {
+    products: Array<{
+        id: string;
+        name: string;
+        description: string;
+        currentVersion: string;
+        availableVersions: string[];
+    }>;
+    tokenInfo: TokenInfo;
+}
+export interface SearchParams {
+    query: string;
+    product?: ProductId | undefined;
+    version?: string | undefined;
+    topic?: TopicId | undefined;
+    limit?: number | undefined;
+    page?: number | undefined;
+    maxTokens?: number | undefined;
+    responseFormat?: ResponseFormat | undefined;
+}
+export interface SearchResult {
+    title: string;
+    url: string;
+    snippet: string;
+    product: string;
+    version?: string;
+    relevance?: number;
+}
+export interface SearchResponse {
+    total: number;
+    results: SearchResult[];
+    query: string;
+    filters?: {
+        product?: string;
+        version?: string;
+        topic?: string;
+    };
+    tokenInfo: TokenInfo;
+    pagination: PaginationInfo;
+}
+export interface GetArticleParams {
+    url: string;
+    includeRelated?: boolean;
+    section?: string | undefined;
+    maxTokens?: number | undefined;
+    responseFormat?: ResponseFormat;
+}
+export interface ParsedArticle {
+    title: string;
+    content: string;
+    url: string;
+    product?: string | undefined;
+    version?: string | undefined;
+    lastUpdated?: string | undefined;
+    breadcrumb?: string[] | undefined;
+    relatedArticles?: Array<{
+        title: string;
+        url: string;
+    }> | undefined;
+}
+export interface ArticleResponse extends ParsedArticle {
+    format: ResponseFormat;
+    tokenInfo: TokenInfo;
+    sections: ArticleSection[];
+}
+export interface GetTocParams {
+    product: ProductId;
+    version?: string;
+    page?: number | undefined;
+    maxTokens?: number | undefined;
+}
+export interface TocEntry {
+    title: string;
+    url: string;
+    children?: TocEntry[];
+}
+export interface TocResponse {
+    product: string;
+    version: string;
+    toc: TocEntry[];
+    tokenInfo: TokenInfo;
+    pagination: PaginationInfo;
+}
+export interface CacheEntry<T> {
+    data: T;
+    timestamp: number;
+    ttl: number;
+}
+export interface CacheOptions {
+    ttl?: number;
+    forceRefresh?: boolean;
+}
+export declare class JamfDocsError extends Error {
+    readonly code: JamfDocsErrorCode;
+    readonly url?: string | undefined;
+    readonly statusCode?: number | undefined;
+    constructor(message: string, code: JamfDocsErrorCode, url?: string | undefined, statusCode?: number | undefined);
+}
+export declare enum JamfDocsErrorCode {
+    NOT_FOUND = "NOT_FOUND",
+    RATE_LIMITED = "RATE_LIMITED",
+    PARSE_ERROR = "PARSE_ERROR",
+    NETWORK_ERROR = "NETWORK_ERROR",
+    INVALID_URL = "INVALID_URL",
+    INVALID_PRODUCT = "INVALID_PRODUCT",
+    CACHE_ERROR = "CACHE_ERROR",
+    TIMEOUT = "TIMEOUT"
+}
+export interface HttpRequestOptions {
+    timeout?: number;
+    headers?: Record<string, string>;
+    retries?: number;
+    retryDelay?: number;
+}
+export interface ToolResult {
+    [key: string]: unknown;
+    content: Array<{
+        type: 'text';
+        text: string;
+    }>;
+    isError?: boolean;
+}
+export interface ZoominSearchResponse {
+    status: string;
+    Results: ZoominSearchResultWrapper[];
+    Pagination?: ZoominPagination;
+}
+export interface ZoominSearchResultWrapper {
+    leading_result: ZoominLeadingResult;
+    follower_result?: ZoominLeadingResult[];
+    bundle_data?: unknown;
+}
+export interface ZoominLeadingResult {
+    title: string;
+    url: string;
+    snippet: string;
+    bundle_id: string;
+    page_id: string;
+    publication_title: string;
+    score?: number;
+    labels?: ZoominLabel[];
+}
+export interface ZoominLabel {
+    key: string;
+    navtitle: string;
+}
+export interface ZoominPagination {
+    CurrentPage: number;
+    TotalPages: number;
+    ResultsPerPage: number;
+    TotalResults: number;
+}
+export type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAMpE;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;CACpB;AAGD,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,SAAS,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,KAAK,CAAC;QACd,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,cAAc,EAAE,MAAM,CAAC;QACvB,iBAAiB,EAAE,MAAM,EAAE,CAAC;KAC7B,CAAC,CAAC;IACH,SAAS,EAAE,SAAS,CAAC;CACtB;AAGD,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAChC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,cAAc,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;CAC7C;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE;QACR,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,SAAS,EAAE,SAAS,CAAC;IACrB,UAAU,EAAE,cAAc,CAAC;CAC5B;AAGD,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAClC,eAAe,CAAC,EAAE,KAAK,CAAC;QACtB,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;KACb,CAAC,GAAG,SAAS,CAAC;CAChB;AAED,MAAM,WAAW,eAAgB,SAAQ,aAAa;IACpD,MAAM,EAAE,cAAc,CAAC;IACvB,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,EAAE,cAAc,EAAE,CAAC;CAC5B;AAGD,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,SAAS,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC;AAED,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,QAAQ,EAAE,CAAC;IAChB,SAAS,EAAE,SAAS,CAAC;IACrB,UAAU,EAAE,cAAc,CAAC;CAC5B;AAGD,MAAM,WAAW,UAAU,CAAC,CAAC;IAC3B,IAAI,EAAE,CAAC,CAAC;IACR,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAGD,qBAAa,aAAc,SAAQ,KAAK;aAGpB,IAAI,EAAE,iBAAiB;aACvB,GAAG,CAAC,EAAE,MAAM;aACZ,UAAU,CAAC,EAAE,MAAM;gBAHnC,OAAO,EAAE,MAAM,EACC,IAAI,EAAE,iBAAiB,EACvB,GAAG,CAAC,EAAE,MAAM,YAAA,EACZ,UAAU,CAAC,EAAE,MAAM,YAAA;CAKtC;AAED,oBAAY,iBAAiB;IAC3B,SAAS,cAAc;IACvB,YAAY,iBAAiB;IAC7B,WAAW,gBAAgB;IAC3B,aAAa,kBAAkB;IAC/B,WAAW,gBAAgB;IAC3B,eAAe,oBAAoB;IACnC,WAAW,gBAAgB;IAC3B,OAAO,YAAY;CACpB;AAGD,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAGD,MAAM,WAAW,UAAU;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IACvB,OAAO,EAAE,KAAK,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;KACd,CAAC,CAAC;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAGD,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,yBAAyB,EAAE,CAAC;IACrC,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B;AAED,MAAM,WAAW,yBAAyB;IACxC,cAAc,EAAE,mBAAmB,CAAC;IACpC,eAAe,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACxC,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;CACtB;AAGD,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;KAC1B,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAChE,CAAC"}

package/dist/types.js

@@ -0,0 +1,28 @@
+/**
+ * Type definitions for Jamf Docs MCP Server
+ */
+// Error types
+export class JamfDocsError extends Error {
+    code;
+    url;
+    statusCode;
+    constructor(message, code, url, statusCode) {
+        super(message);
+        this.code = code;
+        this.url = url;
+        this.statusCode = statusCode;
+        this.name = 'JamfDocsError';
+    }
+}
+export var JamfDocsErrorCode;
+(function (JamfDocsErrorCode) {
+    JamfDocsErrorCode["NOT_FOUND"] = "NOT_FOUND";
+    JamfDocsErrorCode["RATE_LIMITED"] = "RATE_LIMITED";
+    JamfDocsErrorCode["PARSE_ERROR"] = "PARSE_ERROR";
+    JamfDocsErrorCode["NETWORK_ERROR"] = "NETWORK_ERROR";
+    JamfDocsErrorCode["INVALID_URL"] = "INVALID_URL";
+    JamfDocsErrorCode["INVALID_PRODUCT"] = "INVALID_PRODUCT";
+    JamfDocsErrorCode["CACHE_ERROR"] = "CACHE_ERROR";
+    JamfDocsErrorCode["TIMEOUT"] = "TIMEOUT";
+})(JamfDocsErrorCode || (JamfDocsErrorCode = {}));
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AA8JH,cAAc;AACd,MAAM,OAAO,aAAc,SAAQ,KAAK;IAGpB;IACA;IACA;IAJlB,YACE,OAAe,EACC,IAAuB,EACvB,GAAY,EACZ,UAAmB;QAEnC,KAAK,CAAC,OAAO,CAAC,CAAC;QAJC,SAAI,GAAJ,IAAI,CAAmB;QACvB,QAAG,GAAH,GAAG,CAAS;QACZ,eAAU,GAAV,UAAU,CAAS;QAGnC,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;IAC9B,CAAC;CACF;AAED,MAAM,CAAN,IAAY,iBASX;AATD,WAAY,iBAAiB;IAC3B,4CAAuB,CAAA;IACvB,kDAA6B,CAAA;IAC7B,gDAA2B,CAAA;IAC3B,oDAA+B,CAAA;IAC/B,gDAA2B,CAAA;IAC3B,wDAAmC,CAAA;IACnC,gDAA2B,CAAA;IAC3B,wCAAmB,CAAA;AACrB,CAAC,EATW,iBAAiB,KAAjB,iBAAiB,QAS5B"}

package/package.json

@@ -1,10 +1,72 @@
 {
   "name": "@get-technology-inc/jamf-docs-mcp-server",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @get-technology-inc/jamf-docs-mcp-server",
+  "version": "1.0.0",
+  "description": "MCP Server for accessing Jamf Documentation (learn.jamf.com)",
+  "main": "dist/index.js",
+  "type": "module",
+  "bin": {
+    "jamf-docs-mcp-server": "./dist/index.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsx watch src/index.ts",
+    "start": "node dist/index.js",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:unit": "vitest run test/unit",
+    "test:integration": "vitest run test/integration",
+    "test:coverage": "vitest run --coverage",
+    "test:inspector": "npx @modelcontextprotocol/inspector node dist/index.js",
+    "lint": "eslint src/**/*.ts",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run build"
+  },
   "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
+    "mcp",
+    "jamf",
+    "documentation",
+    "model-context-protocol",
+    "jamf-pro",
+    "jamf-school",
+    "jamf-connect",
+    "jamf-protect",
+    "apple",
+    "mdm"
+  ],
+  "author": "GET Technology Inc.",
+  "license": "MIT",
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.0.0",
+    "axios": "^1.7.0",
+    "cheerio": "^1.0.0",
+    "turndown": "^7.2.0",
+    "zod": "^3.23.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.17.0",
+    "@types/node": "^25.0.9",
+    "@types/turndown": "^5.0.5",
+    "@vitest/coverage-v8": "^4.0.17",
+    "eslint": "^9.17.0",
+    "tsx": "^4.19.0",
+    "typescript": "^5.6.0",
+    "typescript-eslint": "^8.18.0",
+    "vitest": "^4.0.17"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/GET-Technology-Inc/jamf-docs-mcp-server.git"
+  },
+  "homepage": "https://github.com/GET-Technology-Inc/jamf-docs-mcp-server#readme",
+  "bugs": {
+    "url": "https://github.com/GET-Technology-Inc/jamf-docs-mcp-server/issues"
+  }
 }