Get the FREE Ultimate OpenClaw Setup Guide →
S

Servicenow Docs

Scanned

@TheSethRose

npx machina-cli add skill @TheSethRose/servicenow-docs --openclaw
Files (1)
SKILL.md
5.1 KB

ServiceNow Documentation Skill

Search and retrieve documentation from docs.servicenow.com and developer.servicenow.com. This skill provides access to ServiceNow's release notes, platform documentation, and developer-focused API references and guides.

When to Use

Use this skill when the user asks about:

  • ServiceNow API documentation (GlideRecord, GlideAjax, GlideQuery, etc.)
  • Release notes, patches, or new features
  • Platform configuration or administration
  • Scripting patterns or best practices
  • Accessibility, UI, or user preferences
  • Any ServiceNow product or feature documentation
  • Developer topics like openFrameAPI, ScriptLoader, spContextManager, or mobile APIs

Tools

servicenow_search

Search the ServiceNow documentation database.

Args:

  • query (string, required) - Search terms (e.g., "GlideRecord", "accessibility preferences", "patch notes")
  • limit (number, default: 10) - Maximum results to return
  • version (string, optional) - Filter by version (e.g., "Washington DC", "Zurich", "Yokohama")

Example:

{"query": "GlideAjax client script", "limit": 5}

servicenow_get_article

Fetch the full content of a documentation article.

Args:

  • url (string, required) - The article URL (automatically converted from Zoomin to docs.servicenow.com)

Example:

{"url": "https://docs.servicenow.com/bundle/zurich-release-notes/page/release-notes/quality/zurich-patch-5.html"}

servicenow_list_versions

List available ServiceNow documentation versions/releases.

Args: None required

servicenow_latest_release

Get release notes for the latest ServiceNow version (automatically detects most recent).

Args: None required

servicenow_dev_suggest

Get autocomplete suggestions from ServiceNow Developer Documentation.

Args:

  • term (string, required) - Partial search term (e.g., "Gli", "openFrame", "spCon")

Example:

{"term": "openFrame"}

servicenow_dev_search

Search ServiceNow Developer Documentation (APIs, guides, references). Returns URLs to API reference pages.

Args:

  • query (string, required) - Search terms (e.g., "openFrameAPI", "spContextManager")
  • limit (number, default: 10) - Maximum results to return

Example:

{"query": "ScriptLoader", "limit": 5}

servicenow_dev_guide

Fetch a ServiceNow Developer Guide by path. Works for PDI guides, developer program docs, etc.

Args:

  • path (string, required) - Guide path (e.g., "developer-program/getting-instance-assistance", "pdi-guide/requesting-an-instance")
  • release (string, default: "zurich") - Release version

Example:

{"path": "developer-program/getting-instance-assistance"}

URL Handling

  • Search API: Uses Zoomin API (servicenow-be-prod.servicenow.com) for searching
  • User-facing URLs: Automatically converted to docs.servicenow.com for readability
  • Article content: Fetched via the Zoomin API endpoint with proper headers
  • Developer Docs Search: developer.servicenow.com GraphQL + databroker search APIs
  • Developer Docs Content: fetched directly from developer.servicenow.com pages

Example Usage

User: "What are the accessibility preferences in ServiceNow?" → Use servicenow_search to find accessibility documentation → Use servicenow_get_article to fetch the full content → Summarize the preferences for the user

User: "Tell me about the latest ServiceNow patch" → Use servicenow_latest_release to get the most recent release notes → Fetch and summarize the patch details

User: "How do I use openFrameAPI?" → Use servicenow_dev_suggest or servicenow_dev_search to find the best developer docs topic → Returns URLs to API reference pages (requires browser access for full content)

User: "Show me the PDI guide for getting an instance" → Use servicenow_dev_guide with path "pdi-guide/requesting-an-instance" → Returns full guide content

APIs Used

  • Zoomin Search API: https://servicenow-be-prod.servicenow.com/search
  • Content Source: docs.servicenow.com (accessed via Zoomin API)
  • Developer Search API: https://developer.servicenow.com/api/now/uxf/databroker/exec
  • Developer Suggest API: https://developer.servicenow.com/api/now/graphql
  • Developer Guides API: https://developer.servicenow.com/api/snc/v1/guides (public, no auth needed)

Limitations

  • API Reference Content: The developer.servicenow.com API reference pages require browser access. servicenow_dev_search returns URLs but cannot fetch the full API documentation content.
  • Guide Content: Guides are fully available via servicenow_dev_guide without authentication.

Source

git clone https://clawhub.ai/TheSethRose/servicenow-docsView on GitHub

Overview

This skill searches ServiceNow docs on docs.servicenow.com and developer docs on developer.servicenow.com to retrieve release notes, platform guides, APIs, and scripting references. It leverages Zoomin-backed search and direct article retrieval to answer questions about features, configuration, and development topics.

How This Skill Works

A user query triggers servicenow_search to locate relevant docs. The article URLs are then fetched with servicenow_get_article to provide full content. For developer topics, the skill uses servicenow_dev_search and servicenow_dev_guide, with automatic URL normalization to docs.servicenow.com for readability.

When to Use It

  • When a user asks for ServiceNow API documentation (e.g., GlideRecord, GlideAjax, GlideQuery)
  • When a user requests release notes, patches, or new features for a specific version
  • When configuring, administering, or platform configuring ServiceNow
  • When seeking scripting patterns, best practices, or UI accessibility guidance
  • When researching developer topics like openFrameAPI, ScriptLoader, spContextManager, or mobile APIs

Quick Start

  1. Step 1: Use servicenow_search with your query and optional version
  2. Step 2: Use servicenow_get_article with the returned URL to fetch full content
  3. Step 3: Summarize key points and provide any relevant developer search if needed

Best Practices

  • Use precise search terms and include version filters when known
  • Verify results against the latest release notes before responding
  • Fetch full article content with servicenow_get_article before summarizing
  • Distinguish between API references, guides, and references when presenting
  • Provide direct article URLs and concise summaries for quick access

Example Use Cases

  • User asks for GlideRecord API documentation and usage examples
  • User wants the latest Zurich release patch notes and highlights
  • User inquires about ScriptLoader usage in developer context
  • User needs openFrameAPI or spContextManager documentation
  • User asks about accessibility preferences and UI configuration

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers