Skip to main content
Glama

environment_check

Checks if the eNSP environment is ready for a topology by detecting VirtualBox and Hyper-V issues, verifying host-only adapters, and confirming required device images are present.

Instructions

只读检查 eNSP、VirtualBox、模板机和设备镜像,不启动或修改任何虚拟机。

检查结果的 readyForTopology=true 才表示这份拓扑的已知前置条件 已满足。检查会识别 VirtualBox 版本、Hyper-V/VBS 冲突、Host-Only 网卡、 AR/WLAN 基机、SVRP 镜像和 USG6000V 镜像/注册状态。

Args: path: 可选的 .topo。给出后按其中实际型号判断 readyForTopology。 models: 可选的计划型号列表;还没创建拓扑时可先检查,例如 ["AR2220", "USG5500"]。与 path 同时给出时合并检查。 ensp_home: 可选的 eNSP 安装目录;省略时从环境、注册表和常见目录查找。

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNo
modelsNo
ensp_homeNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.0

TDQS

A4/5.0
Behavior3/5

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

由于没有注释,描述承担了行为披露责任。明确说明'只读'且'不启动或修改任何虚拟机',这是关键行为信息。但未说明错误处理、权限需求或失败时的表现,如检查失败是否抛出异常或返回何种状态。

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?

结构清晰:开篇概述、解释结果含义、列出参数。内容均必要,无冗余,但描述略长(如检查项列举),可稍简化。整体信息密度高,排序合理。

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?

工具较复杂(3个可选参数),有输出schema但未提供。描述覆盖了检查内容和结果判断,但未说明输出结构细节(如是否包含其他字段)或潜在错误场景。鉴于输出schema存在,不要求描述返回值,但描述未提及任何使用限制或前置条件,仍略有欠缺。

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?

schema描述覆盖率为0%,描述必须补偿。描述对每个参数提供了详细语义:path指定.topo文件用于按实际型号判断,models为计划型号列表且可与path合并,ensp_home指定安装目录并说明省略时的查找逻辑。这远超schema本身。

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?

描述明确指出这是一个只读环境检查工具,具体检查eNSP、VirtualBox、模板机和设备镜像,并列出检查项(VirtualBox版本、Hyper-V/VBS冲突等)。动词'检查'和资源明确,与兄弟工具(拓扑操作和设备操作)区分度高。

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?

描述提到'还没创建拓扑时可先检查',并解释readyForTopology表示前置条件满足,暗示应在拓扑创建前使用。但未明确说明何时不使用或与其他工具(如topo_validate)的替代关系,仅有隐含的使用场景。

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