Skip to content

docs: add ServiceNow tool setup and usage page - #88

Open
thomasvicaire wants to merge 4 commits into
mainfrom
docs/add-servicenow-tool-page
Open

docs: add ServiceNow tool setup and usage page#88
thomasvicaire wants to merge 4 commits into
mainfrom
docs/add-servicenow-tool-page

Conversation

@thomasvicaire

Copy link
Copy Markdown
Contributor

What

Adds documentation for the native ServiceNow tool (MCP server), shipped in dust-tt/dust#29134 (OAuth provider), dust-tt/dust#29135 (server skeleton), and dust-tt/dust#31252 (generic Table API connector v2).

Files changed

  • docs/user-documentation/agents/tools/servicenow.mdx (new): full setup and usage page, following the structure of the other tool pages (Freshservice, NetSuite):
    • Overview and requirements (OAuth 2.0 Authorization Code flow, dedicated integration user).
    • ServiceNow-side setup: create the OAuth application via Application Registry → "Create an OAuth API endpoint for external clients", exact redirect URLs (https://dust.tt/oauth/servicenow/finalize / https://eu.dust.tt/oauth/servicenow/finalize), Global/broadly-scoped application requirement, generated credentials, no OAuth scope needed.
    • API authorization checklist: Table API, GET/POST/PATCH authorized independently, roles and ACLs.
    • Dust-side setup: Spaces → Tools → Add Tools → ServiceNow (instance URL, client ID, client secret), automatic token exchange/refresh.
    • Connection validation steps.
    • Available tools: List Records, Get Record, Create Record, Update Record, with usage tips (number → sys_id lookup, encoded queries, journal fields, silent ACL field absence).
    • "Use the tool efficiently" section recommending a companion Dust skill documenting the customer's instance (approved tables, mandatory fields, state-transition rules, reference-field resolution), with an example skill excerpt.
    • Troubleshooting table (invalid redirect URI, unauthorized_client, "Access to unscoped API is not allowed", 401/403, write failures, missing fields, 429) and limitations.
  • docs.json: adds docs/user-documentation/agents/tools/servicenow to the tools navigation group (after semrush).

Verification

Setup steps and troubleshooting entries verified against the implementation PRs and an end-to-end connection to a ServiceNow Personal Developer Instance.

@mintlify

mintlify Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Dust 🟢 Ready View Preview Sep 1, 2026, 11:31 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@axel-ext-dust axel-ext-dust left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thomasvicaire reviewed and pushed a small fix in 630e4c5 for a wording contradiction in the OAuth scope section: it said "No OAuth scope needs to be configured" and then, one sentence later, recommended adding the useraccount scope to fix API access issues, which read as contradictory.

Reworded it to make both facts clear without the contradiction (no scope needed by default to connect, but useraccount can help with API access issues afterward).

LGTM, you can merge 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants