Skip to main content
Glama

diagnose_mcdev_retrieve_logs

Read-only

Reads bounded historical mcdev retrieve logs for one exact credential, business unit, and query or script key within a UTC window to diagnose retrieval failures without exposing raw log contents.

Instructions

Read-only historical normal-log diagnosis for one exact configured credential/businessUnit and query or script key. Reads only bounded project/logs timestamp files, never error companions or authentication/session contents. Requires caller-managed quiescence. Supports mcdev 10.1.0 and 10.1.1 canonical retrieve credential/BU type key with literal selectors and no options, aliases or quotes, within an explicit UTC ISO millisecond window of at most 24 hours. Returns finite observations and validated basename/time provenance, never raw logs, paths, errors, secrets or remote completeness. No subprocess, network, native execution, elicitation or rerun. Native calls with --noLogFile produce no historical logs; absent evidence is no-match, not a reason to repeat retrieval. Unknown records are suppressed; investigate manually when evidence is insufficient.

Input Schema

NameRequiredDescriptionDefault
keyYes
credentialYes
businessUnitYes
metadataTypeYes
startedAfterYes
startedBeforeYes
workspaceRootYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.0.0

TDQS

A4.2/5.0
Behavior5/5

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

Goes far beyond the readOnly/openWorld/destructive annotations: it discloses exactly what is read (bounded project/logs timestamp files, never error companions or auth/session content), what is excluded (no subprocess, network, native execution, elicitation, rerun), and what is returned (finite observations and basename/time provenance, never raw logs, paths, errors, secrets). It also flags the --noLogFile no-log case and unknown-record suppression, which an agent could not infer from annotations.

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?

Purpose and scope are front-loaded in the first sentence, and every clause carries constraints or exclusions rather than filler. However, several sentences are densely semicolon-packed run-ons (the window/format sentence crowds five restrictions together), making it harder to scan than it needs to be.

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 no-output-schema, seven-required-parameter diagnostic tool, it covers the essentials: quiescence, window bound, selector syntax, negative-evidence semantics, and the shape of the result ('finite observations and validated basename/time provenance'). The main residual gap is that the structure of those 'observations' is never characterized, so the agent must call blind on return shape.

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 has to carry all seven parameters and it mostly does: it pins credential/businessUnit to 'one exact configured' value, constrains metadataType to canonical retrieve query/script keys, and defines the startedAfter/startedBefore pair as a UTC ISO millisecond window of at most 24 hours. It also warns against options, aliases or quotes in selectors. workspaceRoot is never mentioned and exact key format is only implied, so it is not fully compensatory.

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?

Opens with a specific verb+resource: 'Read-only historical normal-log diagnosis for one exact configured credential/businessUnit and query or script key.' That is precise enough to distinguish it from run_mcdev_command and reconcile_mcdev_operation, which operate on live operations rather than historical log files. It stops short of explicitly naming which sibling to prefer, keeping it at 4.

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 real usage constraints: 'Requires caller-managed quiescence' and 'absent evidence is no-match, not a reason to repeat retrieval', plus 'investigate manually when evidence is insufficient'. These tell the agent when this tool applies and when to stop, but no sibling tool is named as an alternative for those cases.

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