Skip to main content
Glama

ninja_query_network_interfaces

Retrieve IP, MAC, and adapter details from network interfaces across all devices, with filtering and pagination support.

Instructions

Query network interface information (IPs, MACs, adapters) across all devices.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dfNoDevice filter expression
pageSizeNoMax results to return
cursorNoPagination cursor from previous response

Implementation Reference

  • Handler lambda that executes the tool logic by calling client.get() with the path '/queries/network-interfaces' and cleaned args.
      handler: async (args, client: NinjaOneClient) => client.get(path, clean(args)),
    };
  • Input schema for the tool — accepts df, pageSize, and cursor (base pagination props) with no extra properties.
    inputSchema: {
      type: 'object',
      properties: { ...basePaginationProps, ...extraProps },
    },
  • Registration of the 'ninja_query_network_interfaces' tool in the queryTools array, exported and aggregated into ALL_TOOLS.
    queryTool(
      'ninja_query_network_interfaces',
      'Query network interface information (IPs, MACs, adapters) across all devices.',
      '/queries/network-interfaces',
    ),
  • Helper function queryTool() used to create the tool definition, including schema and handler, for all query-based tools.
    function queryTool(
      name: string,
      description: string,
      path: string,
      extraProps: Record<string, unknown> = {},
    ): ToolDef {
      return {
        tool: {
          name,
          description,
          inputSchema: {
            type: 'object',
            properties: { ...basePaginationProps, ...extraProps },
          },
        },
        handler: async (args, client: NinjaOneClient) => client.get(path, clean(args)),
      };
    }
Behavior2/5

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

No annotations are present, so the description must fully disclose behavior. It states 'Query' (implying read-only) but does not mention pagination, return format, or any side effects. With no annotations, this is insufficient for a complete behavioral picture.

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 sentence with no redundancy. It efficiently conveys the core purpose without extra words.

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

Completeness3/5

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

Given no output schema, the description partially addresses completeness by listing returned data types (IPs, MACs, adapters). However, it omits details on pagination (cursor, pageSize) and does not explicitly differentiate from the sibling 'ninja_get_device_network_interfaces'.

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?

Schema coverage is 100%, so the baseline is 3. The description does not add any meaning beyond the schema's parameter descriptions. It does not clarify how 'df' works or how pagination parameters interact.

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?

The description clearly identifies the action (Query), the resource (network interface information), and specific data fields (IPs, MACs, adapters). The scope 'across all devices' distinguishes it from the sibling tool 'ninja_get_device_network_interfaces' which is per-device.

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 usage for querying network interfaces across all devices but provides no explicit guidance on when to prefer it over alternatives like 'ninja_get_device_network_interfaces' or any prerequisites.

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/Allied-Business-Solutions/ninjaone-mcp'

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