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

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 GET Technology Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,45 +1,205 @@
-# @get-technology-inc/jamf-docs-mcp-server
+# Jamf Docs MCP Server
 
-## ⚠️ IMPORTANT NOTICE ⚠️
+[![CI](https://github.com/GET-Technology-Inc/jamf-docs-mcp-server/actions/workflows/ci.yml/badge.svg)](https://github.com/GET-Technology-Inc/jamf-docs-mcp-server/actions/workflows/ci.yml)
+[![npm version](https://img.shields.io/npm/v/@get-technology-inc/jamf-docs-mcp-server.svg)](https://www.npmjs.com/package/@get-technology-inc/jamf-docs-mcp-server)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
+An MCP (Model Context Protocol) server that provides AI assistants with direct access to Jamf documentation from learn.jamf.com.
 
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
+## Features
 
-## Purpose
+- 🔍 **Search**: Search across all Jamf product documentation
+- 📖 **Read Articles**: Fetch full article content in Markdown format
+- 📚 **Browse TOC**: Explore documentation structure by product
+- 🏷️ **Product Filtering**: Filter by Jamf Pro, School, Connect, or Protect
+- 💾 **Caching**: Built-in caching for faster responses
 
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@get-technology-inc/jamf-docs-mcp-server`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
+## Supported Products
 
-## What is OIDC Trusted Publishing?
+| Product | Description |
+|---------|-------------|
+| Jamf Pro | Enterprise Apple device management |
+| Jamf School | Education-focused device management |
+| Jamf Connect | Identity and access management |
+| Jamf Protect | Endpoint security for Apple |
 
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
+## Requirements
 
-## Setup Instructions
+- Node.js 20.0.0 or higher
 
-To properly configure OIDC trusted publishing for this package:
+## Installation
 
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
+```bash
+# Clone the repository
+git clone https://github.com/GET-Technology-Inc/jamf-docs-mcp-server.git
+cd jamf-docs-mcp-server
 
-## DO NOT USE THIS PACKAGE
+# Install dependencies
+npm install
 
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
+# Build
+npm run build
+```
 
-## More Information
+## Usage
 
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
+### Quick Start with npx
 
----
+```bash
+npx @get-technology-inc/jamf-docs-mcp-server
+```
 
-**Maintained for OIDC setup purposes only**
+### With Claude Desktop
+
+Add to your `claude_desktop_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "jamf-docs": {
+      "command": "node",
+      "args": ["/path/to/jamf-docs-mcp-server/dist/index.js"]
+    }
+  }
+}
+```
+
+### With Claude Code
+
+```bash
+claude mcp add jamf-docs -- node /path/to/jamf-docs-mcp-server/dist/index.js
+```
+
+### Testing with MCP Inspector
+
+```bash
+npx @modelcontextprotocol/inspector node dist/index.js
+```
+
+## Available Tools
+
+### `jamf_docs_list_products`
+
+List all available Jamf products and their documentation versions.
+
+```
+"What Jamf products have documentation?"
+```
+
+### `jamf_docs_search`
+
+Search Jamf documentation for articles matching your query.
+
+```
+"Search for SSO configuration in Jamf Pro"
+"Find articles about MDM enrollment"
+```
+
+### `jamf_docs_get_article`
+
+Retrieve the full content of a specific documentation article.
+
+```
+"Get the article at https://docs.jamf.com/..."
+```
+
+### `jamf_docs_get_toc`
+
+Get the table of contents for a product's documentation.
+
+```
+"Show me the Jamf Pro documentation structure"
+```
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Run in development mode
+npm run dev
+
+# Build for production
+npm run build
+
+# Run tests
+npm test
+
+# Type check
+npm run typecheck
+```
+
+## Project Structure
+
+```
+jamf-docs-mcp-server/
+├── src/
+│   ├── index.ts          # Entry point
+│   ├── types.ts          # Type definitions
+│   ├── constants.ts      # Configuration
+│   ├── tools/            # MCP tool implementations
+│   │   ├── list-products.ts
+│   │   ├── search.ts
+│   │   ├── get-article.ts
+│   │   └── get-toc.ts
+│   ├── services/         # Core services
+│   │   ├── scraper.ts    # Web scraping
+│   │   └── cache.ts      # Caching
+│   └── schemas/          # Zod validation schemas
+├── .cache/               # Local cache (gitignored)
+├── dist/                 # Build output
+├── package.json
+├── tsconfig.json
+└── CLAUDE.md             # Development guide
+```
+
+## Configuration
+
+The server uses sensible defaults but can be configured via environment variables:
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `CACHE_DIR` | Cache directory | `.cache` |
+| `REQUEST_TIMEOUT` | HTTP timeout (ms) | `15000` |
+| `RATE_LIMIT_DELAY` | Delay between requests (ms) | `500` |
+| `MAX_RETRIES` | Maximum retry attempts | `3` |
+| `RETRY_DELAY` | Delay between retries (ms) | `1000` |
+| `USER_AGENT` | Custom User-Agent string | `JamfDocsMCP/1.0` |
+| `CACHE_TTL_SEARCH` | Search results cache TTL (ms) | `1800000` (30 min) |
+| `CACHE_TTL_ARTICLE` | Article content cache TTL (ms) | `86400000` (24 hr) |
+| `CACHE_TTL_TOC` | TOC cache TTL (ms) | `86400000` (24 hr) |
+| `CACHE_TTL_PRODUCTS` | Products list cache TTL (ms) | `604800000` (7 days) |
+
+Example:
+
+```bash
+CACHE_DIR=/tmp/jamf-cache REQUEST_TIMEOUT=30000 node dist/index.js
+```
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Run tests and type checks
+5. Submit a pull request
+
+## License
+
+MIT - Copyright (c) 2025 GET Technology Inc.
+
+## Maintainer
+
+Developed and maintained by [GET Technology Inc.](https://github.com/GET-Technology-Inc)
+
+## Disclaimer
+
+This is an unofficial tool for accessing Jamf documentation. It is not affiliated with or endorsed by Jamf. Use responsibly and respect Jamf's terms of service.
+
+## Related Resources
+
+- [Jamf Documentation](https://learn.jamf.com)
+- [Jamf Developer Portal](https://developer.jamf.com)
+- [MCP Specification](https://spec.modelcontextprotocol.io/)
+- [MCP TypeScript SDK](https://github.com/modelcontextprotocol/typescript-sdk)

package/dist/constants.d.ts

@@ -0,0 +1,260 @@
+/**
+ * Constants for Jamf Docs MCP Server
+ *
+ * Note: Jamf documentation has moved from docs.jamf.com to learn.jamf.com
+ * The new URL structure is: learn.jamf.com/en-US/bundle/{product}-documentation/page/{page}.html
+ */
+export declare const DOCS_BASE_URL = "https://learn.jamf.com";
+export declare const LEARN_BASE_URL = "https://learn.jamf.com";
+export declare const DOCS_API_URL = "https://learn-be.jamf.com";
+export declare const JAMF_PRODUCTS: {
+    readonly 'jamf-pro': {
+        readonly id: "jamf-pro";
+        readonly name: "Jamf Pro";
+        readonly description: "Apple device management for enterprise";
+        readonly urlPattern: "en-US/bundle/jamf-pro-documentation/page";
+        readonly bundleId: "jamf-pro-documentation";
+        readonly searchLabel: "product-pro";
+        readonly latestVersion: "current";
+        readonly versions: readonly ["current"];
+    };
+    readonly 'jamf-school': {
+        readonly id: "jamf-school";
+        readonly name: "Jamf School";
+        readonly description: "Apple device management for education";
+        readonly urlPattern: "en-US/bundle/jamf-school-documentation/page";
+        readonly bundleId: "jamf-school-documentation";
+        readonly searchLabel: "product-school";
+        readonly latestVersion: "current";
+        readonly versions: readonly ["current"];
+    };
+    readonly 'jamf-connect': {
+        readonly id: "jamf-connect";
+        readonly name: "Jamf Connect";
+        readonly description: "Identity and access management";
+        readonly urlPattern: "en-US/bundle/jamf-connect-documentation/page";
+        readonly bundleId: "jamf-connect-documentation";
+        readonly searchLabel: "product-connect";
+        readonly latestVersion: "current";
+        readonly versions: readonly ["current"];
+    };
+    readonly 'jamf-protect': {
+        readonly id: "jamf-protect";
+        readonly name: "Jamf Protect";
+        readonly description: "Endpoint security for Apple";
+        readonly urlPattern: "en-US/bundle/jamf-protect-documentation/page";
+        readonly bundleId: "jamf-protect-documentation";
+        readonly searchLabel: "product-protect";
+        readonly latestVersion: "current";
+        readonly versions: readonly ["current"];
+    };
+};
+export type ProductId = keyof typeof JAMF_PRODUCTS;
+export declare enum ResponseFormat {
+    MARKDOWN = "markdown",
+    JSON = "json"
+}
+export declare const CACHE_TTL: {
+    readonly SEARCH_RESULTS: number;
+    readonly ARTICLE_CONTENT: number;
+    readonly PRODUCT_LIST: number;
+    readonly TOC: number;
+};
+export declare const CACHE_DIR: string;
+export declare const REQUEST_CONFIG: {
+    readonly TIMEOUT: number;
+    readonly MAX_RETRIES: number;
+    readonly RETRY_DELAY: number;
+    readonly RATE_LIMIT_DELAY: number;
+    readonly USER_AGENT: string;
+};
+export declare const CONTENT_LIMITS: {
+    readonly MAX_SEARCH_RESULTS: 50;
+    readonly DEFAULT_SEARCH_RESULTS: 10;
+    readonly MAX_CONTENT_LENGTH: 100000;
+    readonly MAX_SNIPPET_LENGTH: 500;
+};
+export declare const TOKEN_CONFIG: {
+    readonly DEFAULT_MAX_TOKENS: 5000;
+    readonly MAX_TOKENS_LIMIT: 20000;
+    readonly MIN_TOKENS: 100;
+    readonly CHARS_PER_TOKEN: 4;
+    readonly CODE_CHARS_PER_TOKEN: 3;
+};
+export declare const PAGINATION_CONFIG: {
+    readonly DEFAULT_PAGE: 1;
+    readonly DEFAULT_PAGE_SIZE: 10;
+    readonly MAX_PAGE: 100;
+};
+export declare const JAMF_TOPICS: {
+    readonly enrollment: {
+        readonly name: "Enrollment & Onboarding";
+        readonly keywords: readonly ["enroll", "dep", "ade", "automated device enrollment", "user enrollment", "apple configurator", "onboard", "prestage", "enrollment method"];
+    };
+    readonly 'computer-management': {
+        readonly name: "Computer Management";
+        readonly keywords: readonly ["computer management", "computer inventory", "remote command", "remote administration", "mass action", "unmanag", "check-in", "startup script", "login event"];
+    };
+    readonly 'mobile-management': {
+        readonly name: "Mobile Device Management";
+        readonly keywords: readonly ["mobile device", "iphone", "ipad", "ios", "ipados", "mobile inventory", "mdm capabilities"];
+    };
+    readonly profiles: {
+        readonly name: "Configuration Profiles";
+        readonly keywords: readonly ["configuration profile", "profile", "payload", "restriction", "settings management", "computer configuration", "mobile configuration"];
+    };
+    readonly policies: {
+        readonly name: "Policies";
+        readonly keywords: readonly ["policy", "policies", "execution frequency", "user interaction", "policy management", "policy payload", "trigger"];
+    };
+    readonly packages: {
+        readonly name: "Packages & Deployment";
+        readonly keywords: readonly ["package", "pkg", "dmg", "package deployment", "package management", "installer"];
+    };
+    readonly scripts: {
+        readonly name: "Scripts";
+        readonly keywords: readonly ["script", "bash", "shell", "login script", "startup script", "extension attribute"];
+    };
+    readonly patch: {
+        readonly name: "Patch Management";
+        readonly keywords: readonly ["patch", "patch management", "patch policy", "software update", "patch reporting", "software title", "patch source"];
+    };
+    readonly apps: {
+        readonly name: "App Management";
+        readonly keywords: readonly ["app", "application", "app installer", "vpp", "volume purchase", "managed app", "app store", "mac app store"];
+    };
+    readonly 'self-service': {
+        readonly name: "Self Service";
+        readonly keywords: readonly ["self service", "self-service", "dock item", "branding", "bookmark", "user portal"];
+    };
+    readonly security: {
+        readonly name: "Security Settings";
+        readonly keywords: readonly ["security", "security settings", "restricted software", "efi password", "firmware password", "gatekeeper"];
+    };
+    readonly filevault: {
+        readonly name: "FileVault & Encryption";
+        readonly keywords: readonly ["filevault", "encryption", "recovery key", "disk encryption", "institutional recovery", "personal recovery"];
+    };
+    readonly compliance: {
+        readonly name: "Compliance & Baseline";
+        readonly keywords: readonly ["compliance", "baseline", "compliance baseline", "security benchmark", "cis benchmark", "gdpr"];
+    };
+    readonly 'protect-analytics': {
+        readonly name: "Threat Analytics";
+        readonly keywords: readonly ["analytic", "threat", "detection", "analytic chain", "custom analytic", "jamf-managed analytic", "alert"];
+    };
+    readonly 'protect-plans': {
+        readonly name: "Protect Plans";
+        readonly keywords: readonly ["protect plan", "jamf protect plan", "threat prevention", "endpoint security"];
+    };
+    readonly 'data-integration': {
+        readonly name: "SIEM & Data Integration";
+        readonly keywords: readonly ["siem", "splunk", "sentinel", "elastic", "datadog", "sumo logic", "google secops", "amazon s3", "data stream", "data integration"];
+    };
+    readonly sso: {
+        readonly name: "Single Sign-On";
+        readonly keywords: readonly ["sso", "single sign-on", "saml", "oidc", "oauth", "jamf account", "platform sso"];
+    };
+    readonly ldap: {
+        readonly name: "Directory Services";
+        readonly keywords: readonly ["ldap", "active directory", "directory binding", "open directory", "google secure ldap"];
+    };
+    readonly 'identity-provider': {
+        readonly name: "Identity Providers";
+        readonly keywords: readonly ["identity provider", "idp", "okta", "azure ad", "entra id", "microsoft entra", "google", "cloud identity"];
+    };
+    readonly 'connect-login': {
+        readonly name: "Jamf Connect Login";
+        readonly keywords: readonly ["jamf connect", "login window", "local account", "account creation", "account migration", "mobile account"];
+    };
+    readonly 'connect-password': {
+        readonly name: "Password & Keychain";
+        readonly keywords: readonly ["password sync", "keychain", "password policy", "local password"];
+    };
+    readonly 'privilege-elevation': {
+        readonly name: "Privilege Elevation";
+        readonly keywords: readonly ["privilege elevation", "admin rights", "sudo", "privilege", "self service+"];
+    };
+    readonly users: {
+        readonly name: "Users & Accounts";
+        readonly keywords: readonly ["user account", "local account", "managed local administrator", "mdm-enabled", "user group", "admin account"];
+    };
+    readonly 'user-roles': {
+        readonly name: "Roles & Permissions";
+        readonly keywords: readonly ["user role", "permission", "privilege", "administrator role", "api role", "access level"];
+    };
+    readonly inventory: {
+        readonly name: "Inventory";
+        readonly keywords: readonly ["inventory", "inventory collection", "inventory display", "hardware inventory", "software inventory", "inventory preload"];
+    };
+    readonly 'extension-attributes': {
+        readonly name: "Extension Attributes";
+        readonly keywords: readonly ["extension attribute", "custom attribute", "ea", "custom field", "inventory attribute"];
+    };
+    readonly reports: {
+        readonly name: "Reports & Searches";
+        readonly keywords: readonly ["report", "search", "advanced search", "simple search", "smart group", "criteria", "computer report"];
+    };
+    readonly history: {
+        readonly name: "History & Logs";
+        readonly keywords: readonly ["history", "log", "audit", "audit log", "computer history", "management history", "server log"];
+    };
+    readonly api: {
+        readonly name: "API & Automation";
+        readonly keywords: readonly ["api", "rest api", "classic api", "jamf pro api", "api role", "api client", "bearer token"];
+    };
+    readonly graphql: {
+        readonly name: "GraphQL API";
+        readonly keywords: readonly ["graphql", "query", "mutation", "schema", "protect api"];
+    };
+    readonly webhooks: {
+        readonly name: "Webhooks & Notifications";
+        readonly keywords: readonly ["webhook", "notification", "email notification", "impact alert", "event"];
+    };
+    readonly network: {
+        readonly name: "Network Configuration";
+        readonly keywords: readonly ["wifi", "vpn", "network", "proxy", "firewall", "port", "ip address", "url"];
+    };
+    readonly certificates: {
+        readonly name: "Certificates";
+        readonly keywords: readonly ["certificate", "ssl", "scep", "push certificate", "apns", "signing"];
+    };
+    readonly printers: {
+        readonly name: "Printers";
+        readonly keywords: readonly ["printer", "print", "cups", "ppd"];
+    };
+    readonly 'remote-access': {
+        readonly name: "Remote Access";
+        readonly keywords: readonly ["remote assist", "jamf remote", "teamviewer", "screen sharing", "vnc", "remote administration"];
+    };
+    readonly 'server-admin': {
+        readonly name: "Server Administration";
+        readonly keywords: readonly ["server", "jamf pro server", "activation code", "smtp", "ssl certificate", "maintenance", "health check", "clustering"];
+    };
+    readonly 'change-management': {
+        readonly name: "Change Management";
+        readonly keywords: readonly ["change management", "change log", "version", "backup", "restore"];
+    };
+    readonly licensing: {
+        readonly name: "License Management";
+        readonly keywords: readonly ["license", "licensed software", "license compliance", "license usage", "vpp token"];
+    };
+    readonly education: {
+        readonly name: "Education & Classroom";
+        readonly keywords: readonly ["school", "class", "teacher", "student", "jamf teacher", "jamf student", "jamf parent", "classroom", "education"];
+    };
+    readonly 'school-integration': {
+        readonly name: "School Integrations";
+        readonly keywords: readonly ["apple school manager", "asm", "shared ipad", "location", "google classroom"];
+    };
+};
+export type TopicId = keyof typeof JAMF_TOPICS;
+export declare const SELECTORS: {
+    readonly CONTENT: "article, .article-content, main article, #content";
+    readonly TITLE: "h1";
+    readonly BREADCRUMB: "[class*=\"breadcrumb\"] a, nav[aria-label=\"breadcrumb\"] a";
+    readonly TOC: "nav.related-links a, [class*=\"toc\"] a, [class*=\"sidebar\"] a";
+    readonly RELATED: "nav.related-links a, .related-topics a, [class*=\"related\"] a";
+    readonly REMOVE: "script, style, noscript, footer, [id=\"initial-data\"], [class*=\"cookie\"], [class*=\"tracking\"], [class*=\"analytics\"]";
+};
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAiBH,eAAO,MAAM,aAAa,2BAA2B,CAAC;AACtD,eAAO,MAAM,cAAc,2BAA2B,CAAC;AACvD,eAAO,MAAM,YAAY,8BAA8B,CAAC;AAGxD,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyChB,CAAC;AAEX,MAAM,MAAM,SAAS,GAAG,MAAM,OAAO,aAAa,CAAC;AAGnD,oBAAY,cAAc;IACxB,QAAQ,aAAa;IACrB,IAAI,SAAS;CACd;AAGD,eAAO,MAAM,SAAS;;;;;CAKZ,CAAC;AAGX,eAAO,MAAM,SAAS,QAAsC,CAAC;AAG7D,eAAO,MAAM,cAAc;;;;;;CAMjB,CAAC;AAGX,eAAO,MAAM,cAAc;;;;;CAKjB,CAAC;AAGX,eAAO,MAAM,YAAY;;;;;;CAMf,CAAC;AAGX,eAAO,MAAM,iBAAiB;;;;CAIpB,CAAC;AAGX,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkMd,CAAC;AAEX,MAAM,MAAM,OAAO,GAAG,MAAM,OAAO,WAAW,CAAC;AAG/C,eAAO,MAAM,SAAS;;;;;;;CAcZ,CAAC"}