Search Jamf Documentation
jamf_docs_searchSearch Jamf product documentation by keywords and filter by product, topic, or version to find relevant articles with titles, snippets, and direct links.
Instructions
Search Jamf documentation for articles matching your query.
This tool searches across all Jamf product documentation including Jamf Pro, Jamf School, Jamf Connect, Jamf Protect, Jamf Now, Jamf Safe Internet, and more. Results include article titles, snippets, and direct links.
Args:
query (string, required): Search keywords (2-200 characters)
product (string, optional): Filter by product ID (use jamf_docs_list_products to see all)
topic (string, optional): Filter by topic. Common: enrollment, profiles, policies, packages, scripts, patch, apps, security, filevault, sso, identity-provider, inventory, reports, api, network. See jamf_docs_list_products for the full list of 40 topic IDs.
docType (string, optional): Filter by document type: documentation, release-notes, training, solution-guide, glossary, getting-started
version (string, optional): Filter by version (e.g., "11.13.0") or "current"
language (string, optional): Documentation language/locale (default: en-US)
limit (number, optional): Maximum results per page 1-50 (default: 10)
page (number, optional): Page number for pagination 1-100 (default: 1)
maxTokens (number, optional): Maximum tokens in response 100-50000 (default: 5000)
outputMode ('full' | 'compact'): Output detail level (default: 'full'). Use 'compact' for brief, token-efficient output
responseFormat ('markdown' | 'json'): Output format (default: 'markdown')
Returns: For JSON format: { "total": number, "query": string, "results": [...], "tokenInfo": { "tokenCount": number, "truncated": boolean, "maxTokens": number }, "pagination": { "page": number, "pageSize": number, "totalPages": number, "totalItems": number, "hasNext": boolean, "hasPrev": boolean }, // Pages outside the product documentation, matched on title and ranked // separately from "results", which carry no score to rank them against. // Omitted when none matched. "otherSources"?: [{ "title": string, "url": string, "source": string }] }
For Markdown format: A formatted list of search results with pagination and token info.
Examples (common query → recommended filters):
"Configure SSO with Okta in Jamf Connect" → query="SSO Okta", product="jamf-connect", topic="sso"
"Set up FileVault encryption" → query="FileVault encryption", product="jamf-pro", topic="filevault"
"Patch macOS apps" → query="patch policy", product="jamf-pro", topic="patch"
"Smart group criteria" → query="smart group criteria", product="jamf-pro", topic="reports"
"Automated Device Enrollment workflow" → query="ADE prestage", product="jamf-pro", topic="enrollment"
"Shared iPad in a classroom" → query="shared iPad classroom", product="jamf-school", topic="education"
"Jamf Protect custom analytic" → query="custom analytic", product="jamf-protect", topic="protect-analytics"
"Jamf Pro REST API authentication" → query="API role bearer token", product="jamf-pro", topic="api"
"Extension attribute scripts" → query="extension attribute script", product="jamf-pro", topic="extension-attributes"
"Paginate through results" → query="policy", page=2
Errors:
"No results found" if search returns empty
"Invalid option: expected one of ..." (an input validation error) if product, topic, docType or language is not one of the values the input schema lists
Note: Results are ranked by relevance. Use filters and pagination to navigate large result sets. Most results carry a mapId + contentId pair; pass both to jamf_docs_get_article to fetch that article directly instead of resolving its URL. The pair is omitted when a result comes from a source that does not resolve one — fall back to the URL in that case.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination (1-100, default: 1) | |
| limit | No | Maximum number of results per page (1-50) | |
| query | Yes | Search keywords to find in Jamf documentation | |
| topic | No | Filter by topic. Common: enrollment, profiles, policies, packages, scripts, patch, apps, security, filevault, sso, identity-provider, inventory, reports, api, network. See jamf_docs_list_products for the full list of 40 topic IDs. | |
| docType | No | Filter by document type: documentation, release-notes, training, solution-guide, glossary, getting-started | |
| product | No | Filter by product: jamf-pro, jamf-school, jamf-connect, jamf-protect, jamf-now, jamf-safe-internet, jamf-insights, jamf-rapididentity, jamf-trust, jamf-routines, self-service-plus, jamf-app-catalog, jamf-account, jamf-security-cloud, elevate, composer, jamf-parent, jamf-teacher, jamf-setup-reset, jamf-assessment, title-editor, jamf-infrastructure-manager, jamf-adcs-connector, jamf-pki-proxy, jamf-migrate, jamf-remote-assist, jamf-cloud-distribution-service, healthcare-listener | |
| version | No | Filter by version (e.g., "11.13.0") or "current" | |
| language | No | Documentation language/locale (default: en-US). Options: en-US, ja-JP, zh-TW, de-DE, es-ES, fr-FR, nl-NL, th-TH, it-IT, pt-BR, zh-CN | |
| maxTokens | No | Maximum tokens in response (100-50000, default: 5000) | |
| outputMode | No | Output detail level: "full" for detailed output or "compact" for brief output | full |
| responseFormat | No | Output format: "markdown" for human-readable or "json" for machine-readable | markdown |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | Yes | ||
| limit | No | ||
| query | Yes | ||
| filters | No | ||
| hasMore | Yes | ||
| results | Yes | ||
| totalPages | Yes | ||
| suggestions | No | ||
| versionNote | No | ||
| otherSources | No | ||
| totalResults | Yes | ||
| relevanceNote | No | ||
| paginationNote | No | ||
| filterRelaxation | No | ||
| truncatedContent | No |