Skip to main content
Glama

get_device_os_patch_status

Check OS patch status for a device to identify pending, installed, and failed patches in NinjaOne RMM platform.

Instructions

Get the OS patch status for a specific device, showing pending, installed, and failed patches.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
device_idYesNinjaOne device ID

Implementation Reference

  • Tool registration for 'get_device_os_patch_status' - registers the tool with the MCP server, including its name, description, input schema, and handler function
    // ── Get Device OS Patch Status ───────────────────────────────────────
    server.tool(
      "get_device_os_patch_status",
      "Get the OS patch status for a specific device, showing pending, installed, and failed patches.",
      {
        device_id: z.number().describe("NinjaOne device ID"),
      },
      async ({ device_id }) => {
        try {
          const result = await client.get(`/device/${device_id}/os-patch-installs`);
          return toolResult(JSON.stringify(result, null, 2));
        } catch (error) {
          return toolResult(
            `Error fetching OS patch status: ${error}`,
            true,
          );
        }
      },
    );
  • Input schema definition using Zod - validates that device_id is a required number parameter
    {
      device_id: z.number().describe("NinjaOne device ID"),
    },
  • Handler function that executes the tool logic - makes an HTTP GET request to /device/{device_id}/os-patch-installs endpoint and returns the OS patch status as JSON
    async ({ device_id }) => {
      try {
        const result = await client.get(`/device/${device_id}/os-patch-installs`);
        return toolResult(JSON.stringify(result, null, 2));
      } catch (error) {
        return toolResult(
          `Error fetching OS patch status: ${error}`,
          true,
        );
      }
    },
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. While it indicates this is a read operation ('Get'), it doesn't specify whether authentication is required, if there are rate limits, what format the patch status information is returned in, or whether this operation has side effects. For a tool with zero annotation coverage, this leaves significant behavioral questions unanswered.

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 extremely concise and front-loaded with all necessary information in a single sentence. Every word earns its place: the action ('Get'), the target ('OS patch status for a specific device'), and the scope of information returned ('showing pending, installed, and failed patches'). There is no wasted verbiage or redundant information.

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 the tool's moderate complexity (single parameter, read operation) but lack of annotations and output schema, the description is minimally adequate. It clearly states what the tool does and what information it returns, but doesn't address behavioral aspects like authentication requirements, error conditions, or response format. For a tool with no structured metadata, the description should ideally provide more context about how the tool behaves.

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 description doesn't mention any parameters, but the input schema has 100% description coverage with a single well-documented 'device_id' parameter. According to the scoring rules, when schema_description_coverage is high (>80%), the baseline is 3 even with no parameter information in the description. The description neither adds to nor detracts from the schema's parameter documentation.

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 tool's purpose: 'Get the OS patch status for a specific device' with specific details about what information is returned ('showing pending, installed, and failed patches'). It distinguishes itself from siblings like 'get_device' or 'get_device_software' by focusing specifically on OS patch status. However, it doesn't explicitly contrast with all possible alternatives, keeping it at a 4 rather than 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 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 this tool is appropriate compared to other device information tools like 'get_device_activities' or 'get_device_software', nor does it specify any prerequisites or exclusions. The agent must infer usage from the tool name and description alone.

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/fredriksknese/mcp-ninjaone'

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