Skip to main content
Glama

network_description

Read or replace the description of the currently open file in Packet Tracer.

Instructions

Read the open file's description (the Description button in Packet Tracer), or replace it with text.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
textNoNew description (HTML or plain text). Omit to only read it.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
htmlYes
textYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.2

TDQS

A3.6/5.0
Behavior3/5

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

Annotations declare readOnlyHint=false, destructiveHint=false, and openWorldHint=false, so the agent knows this is a local, non-destructive write. The description adds that 'replace' overwrites the existing description, which is useful signal, but it omits whether the prior value is recoverable or whether the operation requires the file to be saved. Modest added value over annotations.

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?

A single tight sentence with the read case and the write case front-loaded and zero filler. Every clause earns its place.

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?

The tool is simple, has an output schema (so return values need no explanation), and 100% parameter coverage. The description covers both modes adequately. It is only slightly incomplete in not clarifying what happens to the existing description or whether reading returns HTML versus text.

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?

With only one optional parameter and 100% schema description coverage, the schema already documents that `text` accepts HTML or plain text and that omitting it performs a read. The description restates this rather than adding syntax, format, or size constraints beyond what the schema provides, so the baseline of 3 applies.

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 states a specific dual-mode operation: read the open file's description or replace it with `text`. It also maps the concept to a concrete UI affordance (the Description button in Packet Tracer), which grounds the agent's understanding. It does not explicitly distinguish itself from siblings like describe_ipc, so it falls short of a 5.

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 when each mode applies — providing `text` triggers replacement, omitting it reads — but this is also encoded in the schema's default and parameter docs. There is no explicit statement of when to prefer this tool over alternatives, and no prerequisites or preconditions are given.

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