servicenow-platform-mcp

Overview Schema Source Related Servers Score Discussions Admin

describe

Get field metadata for ServiceNow tables, list available tables, or discover script-bearing fields with optional documentation and verbose details.

Instructions

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).

Input Schema

TableJSON Schema

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

TableJSON Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed3 schema fields changedv0.12.0Sep 1, 2026

addedInput schema / properties / field_limit

Added value: +{
+  "default": 25,
+  "title": "Field Limit",
+  "type": "integer"
+}

addedInput schema / properties / field_offset

Added value: +{
+  "default": 0,
+  "title": "Field Offset",
+  "type": "integer"
+}

addedInput schema / properties / name_filter

Added value: +{
+  "default": "",
+  "title": "Name Filter",
+  "type": "string"
+}

First observedv0.10.0May 30, 2026

TDQS

A4.6/5.0

Behavior5/5

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.

Conciseness5/5

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.

Completeness5/5

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.

Parameters5/5

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.

Purpose4/5

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.

Usage Guidelines4/5

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.

Install Server