Skip to main content
Glama
now-sdk-ext-mcp

now-sdk-ext-mcp

Delete Metadata Record

delete_metadata_record
Destructive

Deletes ServiceNow application metadata records through the platform, capturing the DELETE in a named update set and reading it back. Use only when the user explicitly requests removal of a specific record.

Instructions

Delete application metadata through the platform's own Delete, captured as a DELETE in the named update set and read back. Only when the user asked for the delete; deleting a record that other instances already have removes it there too when the set is committed. Writes through the record's form in the named application and update set, then reads back the record and its capture. Refuses protected files, the platform's own schema tables, and access controls (use the ACL tools). Writing code (a script, a server condition, Jelly, a javascript: value, or switching such a record on) is refused when the session does not permit running scripts.

Input Schema

NameRequiredDescriptionDefault
viewNoThe form view to load. The default view when omitted.
scopeNoThe record's application: its scope name (e.g. "x_acme_app"), or "global". Give this or scope_id.
tableYesThe metadata table, e.g. sys_script_include, sys_ui_action, sys_properties.
sys_idYesThe record's sys_id.
instanceNoThe ServiceNow instance auth alias to connect to. This is the alias configured via `snc configure` (e.g., "myinstance", "prod", "test"). The user will typically refer to this by name when saying things like "on my myinstance instance". If not provided, falls back to the SN_AUTH_ALIAS environment variable.
scope_idNoThe record's application by sys_scope sys_id, instead of scope.
update_setYessys_id of an In progress update set of that application (create_update_set). The capture is verified there; for adding a column and for layout saves it must also be the working set (set_current_update_set).
confirm_tableYesRepeat the table exactly.
confirm_sys_idYesRepeat the sys_id exactly.
acknowledge_upgrade_skipNoOnly for an installed Store application, and only after the user has reviewed the change: upgrades of that application then skip this file until the customization is reviewed.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv5.5.0

TDQS

A4.2/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Goes well beyond the annotations (destructiveHint=true, openWorld=true): it discloses that the delete is captured as a DELETE in a named update set and read back, that committing that set propagates the removal to other instances that already have the record, and that the call refuses protected files, platform schema tables, and ACL records. The additional note about refusing code-bearing writes without script permission is real behavioral context an agent could not infer from structured fields.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Purpose is front-loaded, but the body is dense and repetitive: 'Only when the user asked for the delete' partly restates the first sentence, and the phrase 'Writes through the record's form' is confusing for a delete operation. Several clauses about code-writing refusal read as boilerplate carried over rather than delete-specific information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive, ten-parameter mutation with no output schema, the description covers side effects, cross-instance propagation, refused targets, and update-set verification requirements. It stops short of explaining failure behavior or what the read-back yields, but the essentials for safe invocation are present.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the schema already documents all ten parameters including the confirm_table/confirm_sys_id duplicate guards. The description only echoes the concepts of named application and update set without adding format or constraint detail beyond the schema, so baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a concrete verb and resource (delete an application metadata record via the platform's Delete) and immediately distinguishes it from sibling surfaces by naming the ACL tools for access-control records. An agent can tell this apart from query_delete_records or update_metadata_record by the singled-record framing and the update-set capture.

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?

Gives an explicit gating condition ('Only when the user asked for the delete') and an explicit exclusion with a redirect ('access controls (use the ACL tools)'). It does not contrast with the bulk query_delete_records path, so the alternative-routing is incomplete, but the when-to-use signal is clear.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools