Skip to main content
Glama
dvvincent

VergeOS MCP Server

by dvvincent

get_network

Retrieve detailed network configuration and status information from VergeOS virtualization platforms by specifying the network ID.

Instructions

Get detailed information about a specific network

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesNetwork ID

Implementation Reference

  • The core handler implementation for the 'get_network' tool. This method in the VergeOSAPI class makes an HTTP GET request to the VergeOS API endpoint to fetch detailed information about a specific virtual network by its ID.
    async getNetwork(id) {
      return this.request(`/api/v4/vnets/${id}?fields=most`);
    }
  • src/index.js:374-386 (registration)
    Registration of the 'get_network' tool in the TOOLS array, including name, description, and inputSchema specifying that a numeric 'id' is required.
      name: "get_network",
      description: "Get detailed information about a specific network",
      inputSchema: {
        type: "object",
        properties: {
          id: {
            type: "number",
            description: "Network ID",
          },
        },
        required: ["id"],
      },
    },
  • Alternative direct handler for 'get_network' in the local proxy, performing the same API request.
    async function getNetwork(id) { return apiRequest(`/api/v4/vnets/${id}?fields=most`); }
  • Tool registration entry for 'get_network' in the local-proxy TOOLS array.
    { name: "get_network", description: "Get network details", inputSchema: { type: "object", properties: { id: { type: "number" } }, required: ["id"] } },
  • Dispatch logic in the tool call handler switch statement that invokes the getNetwork handler.
    case "get_network":
      result = await api.getNetwork(args.id);
      break;
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states it 'gets detailed information' but doesn't clarify what 'detailed' includes, whether it's a read-only operation, if it requires specific permissions, or what the response format looks like. This leaves significant gaps for a tool with no annotation coverage.

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 a single, efficient sentence that directly states the tool's purpose without unnecessary words. It is appropriately sized and front-loaded, with no wasted content.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the lack of annotations and output schema, the description is incomplete. It doesn't explain what 'detailed information' entails, potential error conditions, or behavioral traits like rate limits. For a tool with no structured metadata, more descriptive context is needed to adequately inform usage.

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?

The input schema has 100% description coverage, with the 'id' parameter clearly documented as 'Network ID'. The description adds no additional semantic context beyond what the schema provides, such as format examples or constraints, so it meets the baseline score of 3 for high schema coverage.

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 clearly states the verb ('Get') and resource ('detailed information about a specific network'), making the purpose understandable. However, it doesn't explicitly differentiate from sibling tools like 'list_networks' (which likely lists multiple networks vs. getting details for one).

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention when to choose 'get_network' over 'list_networks' or other get_* tools, nor does it specify prerequisites or exclusions for usage.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/dvvincent/vergeos-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server