Skip to main content
Glama
Xerrion

servicenow-platform-mcp

code_search

Search ServiceNow code by term and table; list or describe Code Search table coverage.

Instructions

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.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
termNo
limitNo
tableNo
actionNosearch
search_groupNo
extended_matchingNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.0.0
    • addedInput schema / properties / extended_matching
      Added value: +{
      +  "default": false,
      +  "title": "Extended Matching",
      +  "type": "boolean"
      +}
  2. Addedv0.12.0

TDQS

A3.9/5.0
Behavior3/5

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.

Conciseness5/5

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.

Completeness4/5

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.

Parameters5/5

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.

Purpose4/5

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.

Usage Guidelines3/5

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.