Skip to main content
Glama
MCP SAP GUI Server

MCP SAP GUI Server

by kts982

Sap Search Tree Nodes

sap_search_tree_nodes
Read-only

Search loaded SAP tree nodes by text and return matches with full ancestor paths; expand collapsed parent nodes first if expected results are missing.

Instructions

Search for tree nodes by text. Returns matches with full ancestor paths.

Useful for finding nodes in deep trees where the same label appears in multiple branches. Case-insensitive substring match. Optionally pass column to search in a specific column instead of node text.

Important limitation: Only searches nodes that are already loaded (expanded) in the tree. Collapsed subtrees are not searched. If you don't find what you expect, expand parent nodes first using sap_get_tree_node_children with expand=true, then search again.

total_matches counts the matches returned. stopped_early=true means the search reached max_results before the last loaded node, so more matches are possible.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "tree_id": "<tree_id>",
      "search_text": "<search_text>"
    },
    "name": "sap_search_tree_nodes"
  }
}

Input Schema

NameRequiredDescriptionDefault
columnNo
tree_idYes
max_resultsNo
search_textYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A4.8/5.0
Behavior5/5

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

Goes well beyond the readOnly annotations: discloses case-insensitive substring matching, the critical scope limitation that only expanded/loaded nodes are searched, and the meaning of total_matches and stopped_early. This is behavior an agent cannot infer from the schema and directly prevents false-negative conclusions.

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

Conciseness4/5

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

Front-loaded with the action and return shape, then the limitation called out in bold so it cannot be skimmed past. The final paragraph on total_matches/stopped_early partly duplicates the output schema and could be trimmed, but every sentence remains useful.

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?

For a 4-parameter read-only search tool with an output schema, this covers the preconditions (nodes must be expanded), the matching semantics, and the truncation signal — everything needed to call it and to interpret a miss correctly.

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

Parameters4/5

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

With 0% schema description coverage the description must carry the load, and it does explain search_text, column (search a specific column instead of node text), and max_results via the stopped_early note. It stops short of stating accepted column identifier format (header text vs. technical name) and leaves tree_id undocumented, so not a full 5.

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 specific verb and resource ("Search for tree nodes by text") plus the return shape ("matches with full ancestor paths"). The phrase "by text" implicitly contrasts with the path-based sibling sap_find_tree_node_by_path and with sap_read_tree, so an agent can route without opening schemas.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives a positive use case (deep trees where the same label appears in multiple branches), an explicit failure mode (collapsed subtrees aren't searched), and the exact remediation path — call sap_get_tree_node_children with expand=true then retry. It also names the column-scoped alternative inline.

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