servicenow-platform-mcp
This server connects MCP clients to ServiceNow for read-only inspection, investigation, and optionally controlled write operations, with OAuth-based authorization.
Read records from any ServiceNow table via
queryandrecord_read, with field projection, filters, ordering, pagination, display values, aggregates, and label resolution.Describe table schemas and metadata, list tables, and inspect script-bearing fields using
describe.Create, update, or delete records with preview-and-apply safety via
record_writeandrecord_apply.List, read, download, upload, and delete attachments with
attachmentandattachment_write.Run investigations for stale automations, deprecated APIs, table health, ACL conflicts, error analysis, slow transactions, and performance bottlenecks with
investigate.Resolve choice labels to underlying values via
resolve_choice.Work with Service Catalog: list catalogs/categories/items, read item variables, order items, and manage carts via
service_catalog.Analyze catalog answers and journal history (comments, work notes, close notes) with
analysis.Inspect audit configuration and audit trails for tables and fields with
audit.Inspect Flow Designer flows, triggers, and value blobs with
flow.Search ServiceNow code and inspect Code Search table coverage with
code_search.Choose tool packages (
readonly,core_readonly,full,none, or custom groups) to control which capabilities are exposed.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@servicenow-platform-mcpshow me all open incidents with high priority"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
ServiceNow Platform MCP
Connect your MCP client to an existing ServiceNow instance using public OAuth and local stdio transport.
Read records, explore metadata, inspect attachments and flows, search ServiceNow code, and investigate platform issues. With write tools explicitly enabled, you can also stage and apply record or attachment changes.
The server is built for developers and ServiceNow administrators. Your ServiceNow roles, REST policies, and ACLs still control what you can access.
Start here
You'll need Python 3.12+, uv, a ServiceNow instance,
and an MCP client that can run local stdio servers.
Create a public OAuth application in ServiceNow using the authorization-code flow with PKCE and S256. Register this redirect URL:
http://127.0.0.1:8765/oauth/callbackCopy the application's public client ID.
Add the server to your MCP client's configuration. Replace the instance URL and public client ID with your own:
{ "mcpServers": { "servicenow-platform": { "command": "uvx", "args": [ "servicenow-platform-mcp" ], "env": { "SERVICENOW_INSTANCE_URL": "https://your-instance.service-now.com", "SERVICENOW_OAUTH_CLIENT_ID": "your-public-client-id", "MCP_TOOL_PACKAGE": "readonly", "SERVICENOW_ENV": "dev" } } } }Restart the MCP client and call
list_tool_packages.Try a small read request. The first request to ServiceNow opens your default browser and asks you to authorize access.
Run the browser and MCP server on the same machine. Use
uvx servicenow-platform-mcp for the newest available release.
Related MCP server: NowAIKit
Install in your AI client
Choose the setup below for your client and replace the instance URL and public
client ID. Each example starts with the readonly tool package.
Claude Code
Add the server to your Claude Code user configuration:
claude mcp add \
--scope user \
--transport stdio \
servicenow-platform \
--env SERVICENOW_INSTANCE_URL=https://your-instance.service-now.com \
--env SERVICENOW_OAUTH_CLIENT_ID=your-public-client-id \
--env MCP_TOOL_PACKAGE=readonly \
--env SERVICENOW_ENV=dev \
-- uvx servicenow-platform-mcpRun claude mcp list to check that the server was added.
GitHub Copilot in VS Code
Create or edit .vscode/mcp.json in your workspace:
{
"servers": {
"servicenow-platform": {
"type": "stdio",
"command": "uvx",
"args": [
"servicenow-platform-mcp"
],
"env": {
"SERVICENOW_INSTANCE_URL": "https://your-instance.service-now.com",
"SERVICENOW_OAUTH_CLIENT_ID": "your-public-client-id",
"MCP_TOOL_PACKAGE": "readonly",
"SERVICENOW_ENV": "dev"
}
}
}
}Restart VS Code, then trust and start the server when Copilot prompts you.
OpenCode
For a single project, add the server to opencode.json in the project root.
To use it across all projects, add it to ~/.config/opencode/opencode.json:
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"servicenow-platform": {
"type": "local",
"command": [
"uvx",
"servicenow-platform-mcp"
],
"environment": {
"SERVICENOW_INSTANCE_URL": "https://your-instance.service-now.com",
"SERVICENOW_OAUTH_CLIENT_ID": "your-public-client-id",
"MCP_TOOL_PACKAGE": "readonly",
"SERVICENOW_ENV": "dev"
}
}
}
}Restart OpenCode to load the server.
Keep API keys, Basic Auth credentials, passwords, client secrets, access tokens, authorization codes, and PKCE verifiers out of your client configuration.
Configure ServiceNow OAuth
In ServiceNow, open System OAuth > Application Registry. Create an application for this server, or open an existing one, and use these settings:
Setting | Value |
Public Client |
|
Authorization flow | Authorization code with PKCE |
PKCE method |
|
Scope |
|
Redirect URL |
|
Save the application and copy its public client ID into
SERVICENOW_OAUTH_CLIENT_ID. The default scope is useraccount. Only set
SERVICENOW_OAUTH_SCOPE if your application has a different scope enabled.
When an access token expires, the server renews it using the issued refresh token. No client secret is needed. Tokens stay in process memory, so you'll need to authorize again in the browser each time you restart the MCP server.
OAuth authenticates the user. It does not grant table access. Every request still follows the authorized user's REST API policies, roles, table ACLs, field ACLs, and row visibility rules.
Choose a tool package
Use MCP_TOOL_PACKAGE to choose which tools the server loads:
Package | Includes | Recommended use |
| Records, metadata, attachments, investigations, analysis, audits, flows, code search, and CMDB | Normal read-only work |
|
| Minimal inspection access |
| Every tool group, including record and attachment writes | Controlled write workflows |
| Only | Test client connectivity |
For more control, list the tool groups you need, separated by commas:
MCP_TOOL_PACKAGE=query,describe,record_read,attachmentAvailable groups are query, describe, record_write, record_read,
attachment, attachment_write, investigate, resolve_choice,
service_catalog, analysis, audit, flow, code_search, and cmdb.
A tool package controls which tools are loaded, not what you're allowed to do. ServiceNow still checks authorization for each request.
Make your first requests
Use query to fetch a limited set of records. This example requests up to 10
active incidents:
{
"table": "incident",
"fields": "sys_id,number,short_description,state",
"encoded_query": "active=true",
"limit": 10,
"display_values": true
}Use record_read to fetch a single record. Provide either sys_id or name,
but not both:
{
"table": "incident",
"sys_id": "32-character-sys-id",
"fields": "sys_id,number,short_description,state"
}For an unfamiliar table, start with describe:
{
"table": "incident",
"include_docs": true
}These examples require read access to the incident table. Replace it with a
table the authorized user can read if needed. For a tool's complete input details,
use its describe action when available.
Configure from a local checkout
To work on the server locally or run it from source, clone the repository and install its dependencies:
git clone https://github.com/Xerrion/servicenow-platform-mcp.git
cd servicenow-platform-mcp
uv sync --group devCreate .env.local in the directory where the MCP client starts the server:
SERVICENOW_INSTANCE_URL=https://your-instance.service-now.com
SERVICENOW_OAUTH_CLIENT_ID=your-public-client-id
MCP_TOOL_PACKAGE=readonly
SERVICENOW_ENV=devConfigure your client to run uv run servicenow-platform-mcp with the checkout
as its working directory.
The server reads .env first, then .env.local, from that directory. Process
environment variables override values from both files. Keep both dotenv files
out of version control.
Write safely
To enable writes, use full or a custom package that includes record_write or
attachment_write. The authorized ServiceNow user also needs permission to make
those changes.
Record writes are previewed before they're applied. Pass the one-time
preview_token from the preview to record_apply to apply the change.
Set SERVICENOW_ENV=prod or SERVICENOW_ENV=production to block local writes.
For a read-only setup, combine a read-only ServiceNow user with GET-only REST API
policies and MCP_TOOL_PACKAGE=readonly.
Troubleshooting
Problem | What to check |
Configuration fails at startup | Check that the environment variable names match exactly. Make sure the client passes them to the server, or starts it in the directory containing the intended dotenv file. |
Browser does not open | Check that a browser is available on the machine running the MCP server. |
Authorization times out | Run the browser and server on the same machine. Check that the redirect URL exactly matches the one in the Application Registry. |
OAuth token exchange is rejected | Check public-client mode, PKCE S256, the client ID, the enabled scope, and the redirect URL. |
HTTP 401 or | Authorize again on the next call. If the error continues, check scopes, REST API policies, and the user's access. |
HTTP 403 | Check REST resource permissions, roles, table ACLs, and field ACLs. |
Configuration changes do not apply | Restart the MCP server process. |
Security
Grant only the access needed through ServiceNow roles, REST policies, table ACLs, and field ACLs.
Use
readonlyor a smaller custom package wherever possible.Keep API keys, Basic Auth credentials, passwords, and client secrets out of the configuration.
Never log or commit access tokens, authorization codes, PKCE verifiers, or callback URLs containing query strings.
Treat attachments and other ServiceNow content as untrusted data.
Reference
Installation guide: full configuration details, permissions, OAuth behavior, and guidance for running the server
Available Tools
15 toolsanalysisA
Run bounded, read-only analysis over catalog answers or journals.
Args: action: 'ritm_variables' | 'journal_history' | 'describe'. table: Target table for journal_history. sys_id: Target record sys_id for ritm_variables or journal_history. fields_csv: Allowed journal fields: comments, work_notes, close_notes. since: ISO date floor for journal_history; overrides window_days. window_days: Journal window; defaults to 90 days. limit: Row cap; defaults to MAX_ROW_LIMIT and is capped by it. offset: Zero-based row offset.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| since | No | ||
| table | No | ||
| action | Yes | ||
| offset | No | ||
| sys_id | No | ||
| fields_csv | No | ||
| window_days | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full behavioral burden and explicitly discloses that the operation is 'read-only' and 'bounded'. It also adds useful operational details: 'window_days' defaults to 90 days, 'since' overrides it, and 'limit' is capped by MAX_ROW_LIMIT. It omits auth requirements and per-action effects, but the core safety profile is clearly stated.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The one-sentence summary is front-loaded and the Args block is compact with no filler. Each line adds parameter semantics or a default/cap that the schema does not provide, making it appropriately sized.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Parameter semantics and the read-only/bounded behavior are well covered, and an output schema exists so return values need not be documented. However, the three action modes are not explained at the semantic level, and there is no guidance on how 'analysis' relates to overlapping siblings, which leaves the description incomplete for tool selection.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate for all 8 parameters, and it does. Every parameter is explained with allowed values, targets, defaults, or overrides, including the permitted journal fields and the row cap/offset behavior.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The opening line states a specific operation ('bounded, read-only analysis') over defined resources ('catalog answers or journals'), and the Args section names concrete action modes ('ritm_variables', 'journal_history', 'describe'). This is clear but does not distinguish the tool from siblings such as 'query', 'audit', or the sibling also named 'describe'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is given on when to choose this tool over the sibling alternatives or when not to use it. The parameter notes explain mechanics but not the selection context, so an agent must infer usage from the generic word 'analysis'.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
attachmentA
Read attachments. action: 'list' | 'get' | 'download' | 'download_by_name'.
Args: action: One of: list, get, download, download_by_name. sys_id: Attachment sys_id (for get, download). table: Parent table (for list, download_by_name). table_sys_id: Parent record sys_id (for list, download_by_name). file_name: File name (for download_by_name).
| Name | Required | Description | Default |
|---|---|---|---|
| table | No | ||
| action | Yes | ||
| sys_id | No | ||
| file_name | No | ||
| table_sys_id | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must convey behavioral traits. It indicates read-only operation ('Read attachments') but does not disclose idempotency, authentication needs, rate limits, or side effects. The transparency is adequate but not comprehensive.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise, using a clear list format for actions and parameters. Every sentence adds value, and there is no extraneous text.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (5 parameters, no annotations, output schema exists), the description sufficiently covers the action types and parameter mappings. It does not explain return values (handled by output schema), but could benefit from more context on when each action is appropriate.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 0% description coverage, but the tool description compensates well by explaining each parameter's purpose (e.g., 'sys_id: Attachment sys_id (for get, download)'). This adds significant meaning beyond the raw schema fields.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Read attachments' and enumerates specific actions (list, get, download, download_by_name), making the tool's purpose unambiguous and distinguishing it from the sibling tool 'attachment_write'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage via the action parameter but provides no explicit guidance on when to choose this tool over siblings like 'attachment_write' or when not to use it. There is no mention of prerequisites or alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
attachment_writeA
Write attachments. action: 'upload' | 'delete'.
Args: action: 'upload' or 'delete'. table: Parent table (upload). table_sys_id: Parent record sys_id (upload). file_name: Attachment file name (upload). content_base64: Base64-encoded file bytes (upload). content_type: MIME type (upload, default 'application/octet-stream'). sys_id: Attachment sys_id (delete).
| Name | Required | Description | Default |
|---|---|---|---|
| table | No | ||
| action | Yes | ||
| sys_id | No | ||
| file_name | No | ||
| content_type | No | application/octet-stream | |
| table_sys_id | No | ||
| content_base64 | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided. The description lacks disclosure of side effects (e.g., deletion permanence), permission requirements, or error behavior. It only explains parameter usage.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise, front-loaded with the core purpose, and uses a clear bullet-like list for arguments. No redundant information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers parameter semantics adequately but lacks higher-level context such as success/failure responses or limitations. With output schema present, return values may be addressed externally.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description compensates for 0% schema coverage by explaining each parameter's role and conditionally grouping them under upload or delete actions. This adds significant meaning beyond the schema titles.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Write attachments' and specifies two actions: 'upload' and 'delete'. This distinguishes it from sibling tool 'attachment' which likely reads attachments.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use upload vs delete, nor prerequisites or alternatives. The description only lists parameters without usage context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
auditA
Inspect ServiceNow audit posture (table/field config) and audit trail.
IMPORTANT: sys_audit is one of the largest tables on the platform.
Every action keeps a default 90-day window for that reason. Override
window_days (or since on history) only when you genuinely
need older rows - wider windows cause slow queries and can time out.
Args: action: 'check_field' | 'check_fields' | 'check_table' | 'history' | 'describe'. table: ServiceNow table name (required for all actions except 'describe'). field: Field name (required for 'check_field'). fields_csv: Comma-separated field names (required for 'check_fields', 1..50). sys_id: 32-char record sys_id (required for 'history'). since: YYYY-MM-DD cutoff (history only; overrides window_days). window_days: Audit-trail/positive-control window (defaults to 90). limit: Row cap for 'history' (defaults to settings.max_row_limit).
| Name | Required | Description | Default |
|---|---|---|---|
| field | No | ||
| limit | No | ||
| since | No | ||
| table | No | ||
| action | Yes | ||
| sys_id | No | ||
| fields_csv | No | ||
| window_days | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full burden. It explains that the tool inspects posture and trail, and warns about performance implications of wide windows. However, it doesn't explicitly state whether the tool is read-only or if it modifies data, though 'inspect' implies read-only.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Description is well-structured with a brief intro, an important warning, and a clear Args list. It is informative but not overly verbose. Could be slightly more concise by removing redundant 'required for' phrasing, but overall effective.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the complexity (8 parameters, 5 actions), the description covers all necessary usage and constraints. An output schema exists (not shown) which would further help, but the description itself is complete enough for an agent to understand behavior and invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Input schema has 0% description coverage, but the description provides detailed explanations for all 8 parameters including the allowed action values, required fields for each action, and constraints like 1..50 for fields_csv and 32-char sys_id. This adds significant meaning beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description clearly states 'Inspect ServiceNow audit posture (table/field config) and audit trail.' This is a specific verb-resource combination that distinguishes it from sibling tools like query (which retrieves records) and record_read (reads specific records).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides explicit guidance on when to use the tool and when to be cautious: warns about sys_audit table size, default 90-day window, and advises to override window_days or since only when necessary. Also implicitly differentiates from siblings by focusing on audit trail vs general querying.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
code_searchA
Search ServiceNow code or inspect Code Search table coverage.
Args: action: One of 'search', 'list_tables', or 'describe'. term: Search term for action='search'. table: Optional table filter for action='search' (e.g. 'sys_script_include'). search_group: ServiceNow Code Search group; empty uses sn_codesearch.Default Search Group. limit: Max search results for action='search'. Default 20. extended_matching: Include additional Code Search context fields. Default false. Set true when the extra context is needed.
| Name | Required | Description | Default |
|---|---|---|---|
| term | No | ||
| limit | No | ||
| table | No | ||
| action | No | search | |
| search_group | No | ||
| extended_matching | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must carry the behavioral burden. It does disclose useful behavioral details: default limit, default search group, and the effect of extended_matching. But it does not state whether the operation is read-only, what each action returns, or any side effects or permissions needed, so transparency is partial.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the tool's purpose and then uses a clean Arg list without redundant prose. Each line carries meaningful information, and the formatting is scannable for an agent.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
All parameters are explained and defaults are supplied, and an output schema exists so return-value details are not the description's burden. Minor gaps remain in the semantics of 'list_tables' and 'describe' actions, but overall the description provides sufficient context for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 0% description coverage, yet the Args block fully documents all six parameters, including allowed action values, defaults, and when each parameter applies. This more than compensates for the schema's lack of descriptions and gives an agent enough to construct valid calls.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The first sentence states a clear verb and resource: 'Search ServiceNow code or inspect Code Search table coverage.' The action parameter further clarifies three operational modes, making the tool's purpose concrete. It does not explicitly contrast with siblings like 'query' or 'investigate', but the name and core sentence are specific enough.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage context through the action choices and parameter explanations, such as 'term: Search term for action='search'' and 'extended_matching... Set true when the extra context is needed.' However, it never says when to choose this tool over alternatives or when not to use it, leaving the selection guidance mostly implicit.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
describeA
Return slim field metadata for a table, or list tables / script fields.
Args:
table: ServiceNow table name. Required for the default flow and for
action='list_script_fields'. Ignored by
action='list_tables'.
fields: Comma-separated fields to include. Empty returns a bounded
compact page. '*' explicitly returns all fields.
verbose: When True, return the full sys_dictionary row per field
minus a fixed deny-list of high-noise keys. Default False.
include_docs: When True, attach the matching sys_documentation entry
(label/help/hint/url) per field. Default False.
action: When 'list_script_fields', return the dictionary-driven
script-bearing fields for table with its resolved super_class
chain. When 'list_tables', list tables from sys_db_object
(optionally filtered by name_filter). Empty (default) runs
the standard table-describe flow.
name_filter: Substring matched against table name and label when
action='list_tables'. Empty returns all tables (capped).
field_offset: Zero-based field offset for compact default pages.
field_limit: Field count for compact default pages (1-100).
| Name | Required | Description | Default |
|---|---|---|---|
| table | No | ||
| action | No | ||
| fields | No | ||
| verbose | No | ||
| field_limit | No | ||
| name_filter | No | ||
| field_offset | No | ||
| include_docs | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full behavioral burden, and it delivers: it discloses bounded pages, capping, a fixed deny-list for verbose output, the resolved super_class chain for script fields, and default behavior. The read-only nature is implied consistently through 'Return' and 'list' language, and no destructive or surprising side effects are hidden.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core purpose, followed by a tight, well-organized Args list. Each parameter entry earns its place with concrete behavioral detail, and there is no filler or repetition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool has eight parameters, no annotations, and an output schema; the description covers all parameter semantics, action modes, defaults, edge cases, and return-behavior nuances. The presence of an output schema relieves it from explaining return value shape, and nothing essential for correct invocation is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must fully explain all eight parameters, and it does. Every parameter is described with its role, allowed values like '*' or 'list_tables', defaults, and mode-specific behavior, adding meaning far beyond the bare schema names and types.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Return slim field metadata for a table, or list tables / script fields.' This makes the core purpose clear, and the action modes further clarify behavior. However, it does not explicitly distinguish this tool from sibling tools such as query or record_read, so it stops short of full sibling differentiation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear contextual guidance for each action mode, including which parameters are required or ignored for each flow, and how empty vs. explicit values behave. It does not explicitly state when to prefer this tool over sibling alternatives, but the internal usage conditions are strong and actionable.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
flowA
Inspect Flow Designer flows, triggers, and value blobs (read-only).
Args: action: 'contract' | 'inspect' | 'find_by_table' | 'decode_values' | 'list_triggers' | 'describe'. sys_id: Flow sys_id (contract/inspect; mutually exclusive with name). name: Flow name (contract/inspect; mutually exclusive with sys_id). value: gzip+base64+JSON blob to decode (decode_values). table: Target table (find_by_table; optional filter for list_triggers). trigger_type: Trigger type filter (list_triggers, e.g. 'record_update'). active: 'true' | 'false' filter (list_triggers). limit: Row cap for list_triggers (default 100). sections: Comma-separated inspect/contract sections. Empty uses the compact default; '*' returns all. section_limit: Shared cap for selected flow rows/nodes (default 100, max MAX_ROW_LIMIT).
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| limit | No | ||
| table | No | ||
| value | No | ||
| action | Yes | ||
| active | No | ||
| sys_id | No | ||
| sections | No | ||
| trigger_type | No | ||
| section_limit | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations present, the description carries the full safety burden and explicitly declares 'read-only' up front. It also discloses defaults and caps for limit, section_limit, and sections behavior, plus the sys_id/name mutual exclusion, which are meaningful beyond the schema fields.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a compact, front-loaded docstring: one purpose sentence followed by a parameter-to-action map. No line is redundant; the actionable constraints (mutual exclusivity, defaults, wildcard behavior) are included without fluff.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a ten-parameter, six-action tool with no schema descriptions, the description addresses almost all invocation details, and an output schema is available for return values. The main residual gap is that the 'contract' action is named and referenced by 'sections' but never defined, which leaves some ambiguity for an agent deciding to use it.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, and the description compensates completely by defining the action enum, which parameter applies to which action, value encoding, defaults, and the sys_id/name exclusivity constraint. Every parameter receives semantic context that is not visible in the input schema alone.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The opening line names a specific action and resource: 'Inspect Flow Designer flows, triggers, and value blobs (read-only).' The args list clarifies it is a multi-action utility, but it does not explicitly contrast itself with sibling tools such as query, record_read, or describe, so sibling differentiation is left to the reader.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The Args section associates each parameter with the action in which it is used (e.g., 'value: gzip+base64+JSON blob to decode (decode_values)'), which implies the appropriate invocation pattern. It never states when to prefer this tool over sibling alternatives or when not to use it, leaving the selection criteria implicit.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
investigateA
Run an investigation or explain a finding.
Args: action: 'run' | 'explain' | 'describe'. name: Investigation name (required for 'run'; optional direct selector for 'explain' and filter for 'describe'). Available: stale_automations, deprecated_apis, table_health, acl_conflicts, error_analysis, slow_transactions, performance_bottlenecks. params: JSON string of run parameters (run only). element_id: 'table:sys_id' identifier of a finding (explain only).
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| action | Yes | ||
| params | No | {} | |
| element_id | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
'There are no annotations, so the description carries the full burden of behavior explanation. It does disclose the mode-based behavior and parameter applicability, which is useful. However, it does not describe the effects of running an investigation, whether it creates or modifies state, what the output looks like beyond the output schema, or any side effects or failure conditions.'
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loaded with the single-sentence purpose, followed by a tight Args block that covers all four parameters without redundancy. Every sentence contributes operational information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a four-parameter tool with no annotations and 0% schema coverage, the description is largely complete: it provides action values, investigation name options, and parameter-specific rules. The main remaining gap is the expected inner structure of the 'params' JSON string for 'run', which is left to the caller to know. The existence of an output schema reduces the need to document return values, so the overall definition is still quite complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the parameter burden falls entirely on the description, and it delivers. It explains each parameter in plain language: the accepted values of action, the role of name across modes, that params is a JSON string used only for 'run', and that element_id is a 'table:sys_id' identifier for 'explain'. It even lists available investigation names, making parameter choice actionable.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Run an investigation or explain a finding,' and then defines three distinct actions: 'run', 'explain', and 'describe'. It clearly maps the tool's scope, though it does not explicitly differentiate itself from siblings like 'describe', 'analysis', or 'audit', which leaves a small ambiguity.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
'The description gives clear action-specific usage context: name is 'required for 'run'', optional as a direct selector for 'explain', and a filter for 'describe'; params is 'run only'; and element_id is 'explain only'. This is strong contextual guidance, but it does not explicitly state when to prefer this tool over alternatives or when not to use it.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_tool_packagesA
List all available tool packages and their tool groups.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description discloses the basic read operation but provides no details on authentication requirements, potential rate limits, or any side effects. With no annotations, more behavioral context would be helpful, but the simplicity of a list operation mitigates the gap.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence with no unnecessary words. It is front-loaded with the action and resource, making it easy to parse.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the simplicity of the tool (no parameters, no annotations, output schema exists), the description is minimally sufficient. However, it could clarify what 'tool packages' and 'tool groups' are or if any preconditions exist.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has zero parameters, so schema coverage is 100%. The description does not need to add parameter meaning; the baseline score of 4 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('List') and the resource ('all available tool packages and their tool groups'). It distinguishes from sibling tools like 'query' or 'record_read' which have different purposes.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is given on when to use this tool versus alternatives. There is no mention of prerequisites, context, or exclusions, leaving the agent to infer usage solely from the tool name.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
queryA
Read records, aggregates, or a single record from any ServiceNow table.
Args:
table: ServiceNow table name (e.g. 'incident').
sys_id: When set, fetch a single record by sys_id (other filter args ignored
except fields and display_values).
encoded_query: ServiceNow encoded query string (e.g. 'state=1^priority=2').
Empty = no filter.
fields: Comma-separated field projection. List mode requires this argument.
'*' explicitly requests all masked fields. Exact sys_id mode defaults
to the compact sys_id,sys_updated_on projection.
limit: Max rows (1-max_row_limit). Default 20.
offset: Pagination offset.
order_by: Field name; prefix with '-' for descending (e.g. '-sys_created_on').
display_values: True returns display_value form for reference and choice fields.
aggregate: Comma-separated aggregations: 'count', 'avg:', 'sum:',
'min:', 'max:'. When set, returns aggregate result instead of rows.
group_by: Comma-separated fields to group by, e.g. state,active (aggregate mode only).
resolve_labels: Comma-separated 'field=label' pairs (e.g. 'state=open,priority=high').
Each label is resolved via ChoiceRegistry to its underlying value, then ANDed
into encoded_query as 'field=value'.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| table | Yes | ||
| fields | No | ||
| offset | No | ||
| sys_id | No | ||
| group_by | No | ||
| order_by | No | ||
| aggregate | No | ||
| encoded_query | No | ||
| display_values | No | ||
| resolve_labels | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden, and it does a good job: it discloses that sys_id ignores other filter args except fields and display_values, that aggregate mode returns aggregates instead of rows, that list mode requires fields, and exactly how resolve_labels gets ANDed into the encoded query. It could add permission and max-row-limit specifics, but the core behavioral quirks are covered.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A one-line summary is front-loaded, and the Args block that follows is dense but justified: 11 parameters each get behavior that the schema lacks, so every sentence earns its place. It is long because it must be, not because of wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For an 11-parameter tool with no annotations and an output schema (so return shapes needn't be explained), the description covers all argument semantics and mode behaviors thoroughly. The remaining gaps are minor: max_row_limit is referenced but never quantified, and the description gives no hint about when to choose this over record_read, so selection across read siblings is left to inference.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0% — the schema provides only titles, types, and defaults — so the description must compensate, and it fully does. All 11 parameters get precise semantics: prefixes such as '-' for descending order_by, comma-separated aggregate/group_by syntax, the fields projection rules, and the interaction between sys_id, fields, and display_values. This is exactly the compensation a 0%-coverage schema requires.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The opening line 'Read records, aggregates, or a single record from any ServiceNow table' states a specific verb, resource, and three distinct modes, so the tool's job is immediately clear. However, it never distinguishes itself from the sibling record_read tool, which appears to overlap in purpose.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no explicit when-to-use vs. when-not-to-use guidance and no mention of the record_read sibling, so an agent must infer which read tool to pick. Usage context is only implied through argument semantics (e.g., sys_id selects single-record mode, aggregate returns aggregates instead of rows).
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
record_applyA
Commit a previously previewed write. Single-use token.
Args:
preview_token: The token returned by record_write in preview
mode. Single-use - consumed on success or failure.
| Name | Required | Description | Default |
|---|---|---|---|
| preview_token | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Without annotations, it discloses key behavior: the token is single-use and consumed on success or failure, indicating idempotency and ensuring the agent understands the token's lifecycle.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences plus a bullet, no fluff, purpose is front-loaded. Every word adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple commit tool with one parameter and an output schema, the description covers the essential behavior and usage. Minor gaps in error details, but overall sufficient.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With 0% schema description coverage, the description compensates by explaining the preview_token parameter's origin and single-use nature, adding crucial context beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description explicitly states 'Commit a previously previewed write', using a specific verb ('commit') and resource ('previewed write'), differentiating it from siblings like 'record_write' which handles previews.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It clearly states to use after a preview with record_write, and specifies the token origin. Though it does not explicitly list when not to use, the context is sufficient.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
record_readA
Fetch a record by sys_id or name from any table.
Exactly one of sys_id or name must be supplied. Sensitive fields
are masked. The response includes a script_fields list (resolved
dynamically via sys_dictionary plus the table's super_class chain)
so callers can discover which script-bearing fields are writable on a
subsequent record_write.
Args:
table: ServiceNow table name (e.g. sys_script,
catalog_script_client, incident). Tables with zero
script fields return script_fields: [] and succeed.
sys_id: Mutually exclusive with name. Direct lookup by sys_id.
name: Mutually exclusive with sys_id. Resolves via
name=<value> query; ambiguous matches return an error.
fields: Comma-separated field projection. Empty returns compact
identity/update metadata plus all discovered script-bearing fields.
'*' returns the full masked record.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| table | Yes | ||
| fields | No | ||
| sys_id | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden, and it delivers: sensitive fields are masked, script_fields is resolved via sys_dictionary and super_class chain, zero-script-field tables succeed with an empty list, and ambiguous name lookups error. This gives an agent accurate expectations beyond the input schema.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is longer than average but well-organized with a front-loaded purpose sentence and an Args section. The behavioral details about script_fields are relevant and earn their place. Minor redundancy exists because mutual exclusivity is stated both up front and within each parameter, but overall structure is effective.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read tool with no annotations and no schema-level parameter descriptions, this definition covers the key operational context: required/optional parameters, edge cases, return behavior, and integration with a subsequent record_write. The presence of an output schema means return-value structure does not need to be duplicated in the description.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must fully compensate, and it does. Every parameter is explained: table with examples, sys_id with mutual exclusivity, name with resolution semantics and ambiguity errors, and fields with projection and empty-value behavior. This is a complete parameter contract.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The first sentence clearly states the verb and resource: 'Fetch a record by sys_id or name from any table.' This distinguishes it from siblings like query, record_write, and describe by specifying a direct record-fetch operation by identifier. The scope is concrete and immediately actionable.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear invocation context: exactly one of sys_id or name must be supplied, and ambiguous name matches return an error. It explains the relationship to record_write by mentioning script_fields discovery, but it does not explicitly contrast this tool with query or other read-oriented siblings. Still, the usage conditions are unambiguous.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
record_writeA
Create, update, or delete a record. Defaults to preview mode.
Supply all field values, including complete script or markup strings,
in data. Omitted fields stay unchanged on update. Dictionary
metadata identifies supplied XML fields, including inherited fields;
malformed XML is rejected before preview creation or mutation.
Creates also check inherited mandatory fields, with child declarations
taking precedence. Metadata request errors block writes.
Args: action: 'create' | 'update' | 'delete'. table: Target table. Required. sys_id: Required for 'update' and 'delete'. data: JSON string mapping field names to values, including any script fields. Required for 'create' and 'update'. Maximum 256 KiB of UTF-8 JSON, including escaping and field names. preview: When True (default) returns a preview_token; caller invokes record_apply to commit. When False, write commits immediately.
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | ||
| table | No | ||
| action | Yes | ||
| sys_id | No | ||
| preview | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full behavioral burden and does so thoroughly. It discloses preview-mode default, commit behavior, update semantics for omitted fields, XML validation, inherited-field checks, metadata error blocking, and size limits. This is unusually transparent for a mutation tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is long but every sentence carries operational value. It front-loads the core purpose and default behavior, then uses a structured Args list to map details to parameters. The format is scannable and free of filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given a five-parameter write tool with no annotations, the description is complete: it covers action constraints, required fields, data format, size limits, preview flow, XML behavior, and error conditions. An output schema exists, so not describing the full return shape is acceptable. Nothing essential for invoking the tool correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description compensates fully for the 0% schema description coverage by documenting every parameter: action enum values, table and sys_id requirements, data format and maximum size, and preview semantics. It adds meaning well beyond the bare schema titles and defaults, including required conditions per action.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description explicitly states the tool creates, updates, or deletes a record, using specific verbs and a clear resource. It differentiates from siblings like record_apply (which commits previews), record_read (which reads), and attachment_write (which writes attachments). The purpose is immediately understandable and distinct.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description clearly defines the actions this tool supports and explains when the preview mode requires calling record_apply to commit. It does not explicitly contrast with record_read or other sibling write tools, but the action-specific guidance and preview/commit flow provide solid contextual direction. It lacks an explicit 'when not to use' statement, so it falls just short of a 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
resolve_choiceA
Resolve a choice label to its underlying value via ChoiceRegistry.
Args: table: ServiceNow table name. field: Field name on that table. label: Choice label to resolve. When empty, returns the full {label: value} mapping for the field.
| Name | Required | Description | Default |
|---|---|---|---|
| field | Yes | ||
| label | No | ||
| table | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It explains the conditional behavior (returns mapping if label empty) but does not disclose error handling, authentication requirements, or rate limits. The read-only nature is implied but not explicitly stated.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise with only three sentences, front-loading the purpose and listing parameters efficiently. No unnecessary words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's simplicity and the existence of an output schema, the description covers key behaviors. It could mention the output format more explicitly, but overall it is sufficiently complete for an agent to use correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Despite schema description coverage being 0%, the description explicitly explains each parameter: 'ServiceNow table name', 'Field name on that table', and the special behavior of the label parameter when empty. This adds significant meaning beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: resolving a choice label to its underlying value via ChoiceRegistry. It also distinguishes from siblings by specifying a unique function not shared by other tools in the list.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage for resolving choice labels and optionally getting the full mapping when label is empty. However, it does not provide explicit when-to-use or when-not-to-use guidance, nor does it mention alternatives among siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
service_catalogB
Service Catalog operations. Dispatch on action.
Args: action: One of: catalogs_list, catalog_get, categories_list, category_get, items_list, item_get, item_variables, order_now, add_to_cart, cart_get, cart_submit, cart_checkout. sys_id: Record sys_id (catalog_get, category_get, item_get, item_variables). item_sys_id: Catalog item sys_id (order_now, add_to_cart). catalog_sys_id: Catalog sys_id (categories_list). catalog: Filter by catalog sys_id (items_list). category: Filter by category sys_id (items_list). text: Search text (catalogs_list, items_list). variables: JSON object of variable name/value pairs (order_now, add_to_cart). limit: Max results (catalogs_list, categories_list, items_list). Default 20. offset: Pagination offset (categories_list, items_list). Default 0. top_level_only: Return only top-level categories (categories_list).
| Name | Required | Description | Default |
|---|---|---|---|
| text | No | ||
| limit | No | ||
| action | Yes | ||
| offset | No | ||
| sys_id | No | ||
| catalog | No | ||
| category | No | ||
| variables | No | ||
| item_sys_id | No | ||
| catalog_sys_id | No | ||
| top_level_only | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description lacks disclosure of behavioral traits such as idempotency, side effects (e.g., order_now is likely destructive), or required permissions. No annotations exist to compensate. While actions like 'catalogs_list' are read-only, actions like 'cart_checkout' imply write operations, but this is not clarified.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with a clear opening line and a bullet list of parameters. It is reasonably concise given the complexity of 11 parameters and multiple actions. Minor redundancy exists (e.g., repeating action names in parameter explanations), but overall it is efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with 11 parameters and many actions, the description covers most critical usage aspects: parameter-action mappings and defaults. Since an output schema exists, the lack of return value descriptions is acceptable. However, ordering constraints or pagination details could be more explicit.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has no parameter descriptions (0% coverage), but the description adds meaningful context by explicitly listing which parameters apply to which actions (e.g., sys_id for catalog_get). This significantly compensates for the schema gap, though a few parameters like 'variables' could have more detail on format.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states that this tool handles Service Catalog operations by dispatching on an 'action' parameter. It enumerates specific actions like catalogs_list and order_now, making the resource explicit. However, it does not differentiate from sibling tools like 'query' or 'record_read', which might also handle catalog-related data.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided on when to use this tool versus alternatives. The description simply lists actions without indicating preferred use cases or dependencies. Given the sibling tools (e.g., 'query', 'record_read'), explicit guidance on when to use this dispatcher would improve clarity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
2 tool updates
v1.0.0- Changed
code_search1 field changed- added
Input schema / properties / extended_matchingAdded value: +{ + "default": false, + "title": "Extended Matching", + "type": "boolean" +}
- Changed
record_write2 fields changed- removed
Input schema / properties / script_fieldRemoved value: -{ - "default": "", - "title": "Script Field", - "type": "string" -} - removed
Input schema / properties / script_pathRemoved value: -{ - "default": "", - "title": "Script Path", - "type": "string" -}
6 tool updates
v0.12.0- Added
analysis - Removed
build_query - Added
code_search - Changed
describe3 fields changed- added
Input schema / properties / field_limitAdded value: +{ + "default": 25, + "title": "Field Limit", + "type": "integer" +} - added
Input schema / properties / field_offsetAdded value: +{ + "default": 0, + "title": "Field Offset", + "type": "integer" +} - added
Input schema / properties / name_filterAdded value: +{ + "default": "", + "title": "Name Filter", + "type": "string" +}
- Changed
flow2 fields changed- added
Input schema / properties / section_limitAdded value: +{ + "default": 0, + "title": "Section Limit", + "type": "integer" +} - added
Input schema / properties / sectionsAdded value: +{ + "default": "", + "title": "Sections", + "type": "string" +}
- Changed
record_read1 field changed- added
Input schema / properties / fieldsAdded value: +{ + "default": "", + "title": "Fields", + "type": "string" +}
14 tool updates
v0.10.0- First observed
attachment - First observed
attachment_write - First observed
audit - First observed
build_query - First observed
describe - First observed
flow - First observed
investigate - First observed
list_tool_packages - First observed
query - First observed
record_apply - First observed
record_read - First observed
record_write - First observed
resolve_choice - First observed
service_catalog
TDQS
Scored across 15 tools
Most tools have distinct purposes, but `query` and `record_read` overlap in single-record fetching, and `attachment` vs `attachment_write` require careful reading to distinguish read vs write operations. Descriptions otherwise clarify boundaries well.
Naming is mixed: some tools use verb_noun (`record_write`, `attachment_write`, `list_tool_packages`), while others are bare nouns (`attachment`, `flow`, `audit`) or bare verbs (`query`, `investigate`, `describe`). Many tools are action-dispatch style with a single name, creating inconsistent patterns.
15 tools is at the upper end of the ideal range, but the broad ServiceNow platform scope (records, attachments, catalog, flows, audit, code search, analysis) justifies each tool's existence. No obvious bloat or missing core utility.
The surface covers CRUD for records, attachments, catalog operations, flow inspection, audit checks, and code search. Minor gaps exist (e.g., no update/delete for attachments besides upload/delete, no flow modification), but the core workflows are well covered.
Maintenance
Related MCP Connectors
Let AI agents query data and act across all your business apps via MCP.
Unified MCP Server is a remote MCP connector for AI agents and vertical AI products that provides access to 22,000+ authorized SaaS tools across 400+ integrations and 24 categories directly inside LLMs (Claude, GPT, Gemini, Cohere). Tools operate only on explicitly authorized customer connections, enabling agents to safely read and write against live third-party systems.
Governed app access for AI agents: 1,000+ apps & 12,000+ tools via Code Mode MCP.
Your org's AI agents, tasks, runs, search, and brain files as MCP tools and resources.
Related MCP Servers
- AlicenseAqualityDmaintenanceEnables natural language interaction with ServiceNow instances for managing incidents, changes, CMDB, service catalog, users, groups, and knowledge base via MCP.4116 npmMIT
- AlicenseCqualityAmaintenanceEnables AI to interact with ServiceNow instances via MCP, providing 400+ tools across all modules for automation, development, and management.500805 npm17Elastic 2.0
- AlicenseCqualityBmaintenanceEnables natural language control of ServiceNow from AI clients like Claude and Cursor. Provides 400+ tools for incidents, changes, CMDB, and scripts via MCP protocol.100286 npm2MIT
- AlicenseNot gradedqualityDmaintenanceEnables AI assistants to interact with ServiceNow instances for data retrieval, record management, and workflow execution via the ServiceNow API.MIT