Skip to main content
Glama

ninja_submit_software_patch_scan

Initiate a software patch scan on a specific device to identify missing updates and security patches.

Instructions

Trigger a software patch scan on a device.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesDevice ID

Implementation Reference

  • Tool definition and handler for ninja_submit_software_patch_scan. The handler triggers a software patch scan on a device by calling POST /device/{id}/patch/software/scan.
    {
      tool: {
        name: 'ninja_submit_software_patch_scan',
        description: 'Trigger a software patch scan on a device.',
        inputSchema: {
          type: 'object',
          required: ['id'],
          properties: {
            id: { type: 'number', description: 'Device ID' },
          },
        },
      },
      handler: async ({ id }, client: NinjaOneClient) =>
        client.post(`/device/${id}/patch/software/scan`),
    },
  • Input schema for ninja_submit_software_patch_scan: requires a device ID (number).
    inputSchema: {
      type: 'object',
      required: ['id'],
      properties: {
        id: { type: 'number', description: 'Device ID' },
      },
    },
  • src/index.ts:24-24 (registration)
    Registration via ALL_TOOLS array: deviceTools (which includes ninja_submit_software_patch_scan) is exported from tools/index.ts, imported into src/index.ts, and mapped into toolMap by name for handling.
    const toolMap = new Map(ALL_TOOLS.map((def) => [def.tool.name, def.handler]));
  • ALL_TOOLS aggregated array where deviceTools (containing ninja_submit_software_patch_scan) is spread in.
    export const ALL_TOOLS = [
      ...deviceTools,
  • ToolDef interface used to type each tool definition, combining a Tool schema and a handler function.
    export interface ToolDef {
      tool: Tool;
      // eslint-disable-next-line @typescript-eslint/no-explicit-any
      handler: (args: any, client: NinjaOneClient) => Promise<unknown>;
    }
Behavior2/5

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

No annotations provided, so the description carries the full burden. It does not disclose whether the scan is synchronous or asynchronous, what happens if the device is offline, or success/failure indicators. Minimal behavioral detail.

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?

The description is a single short sentence, very concise and front-loaded. However, it may be too minimal for actionable use.

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 number of sibling tools and no output schema, the description lacks context about prerequisites, return behavior, or whether this triggers an async process. Incomplete for a complex action tool.

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?

Only one parameter 'id' with schema description 'Device ID'. Description adds no extra meaning beyond the schema. Since schema coverage is 100%, baseline is 3.

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 uses the specific verb 'Trigger' and clearly identifies the resource 'software patch scan on a device'. It distinguishes from sibling tools like ninja_submit_os_patch_scan (OS patches) and ninja_submit_software_patch_apply (applying patches).

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?

No guidance on when to use this tool versus alternatives. With many sibling tools (e.g., ninja_submit_os_patch_scan, ninja_query_software_patches), explicit usage context is missing.

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