Skip to main content
Glama
OpenCyber Harness
by mitkox

oc_workspace_list

Read-onlyIdempotent

List files in an OpenCyber engagement workspace with recursive paths and limit/offset pagination. Reports total entries and coverage; limit 0 returns all entries.

Instructions

List files within the OpenCyber engagement workspace. Reports total_entries and coverage; a bounded page returns next_offset and a continuation. limit=0 (default) returns every entry.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "engagement_id": "<engagement_id>"
    },
    "name": "oc_workspace_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNo.
limitNo
offsetNo
recursiveNo
engagement_idYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent and non-destructive, and the description adds genuinely new behavior: it reports total_entries and coverage, and a bounded page returns next_offset plus a continuation token. The limit=0 default behavior is a non-obvious trait worth calling out. It stops short of 5 by not mentioning permissions, ordering, or large-result implications.

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?

Three tight sentences, front-loaded with the purpose before the return-shape detail. Every sentence carries information, though the middle clause about total_entries/coverage is terse enough to read as jargon.

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?

Because an output schema exists, the description does not need to enumerate return fields, and the pagination note covers the main non-obvious aspect. The gap is that with 5 params at 0% schema coverage, recursive and path semantics go unexplained for a workspace traversal 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?

Schema description coverage is 0%, so the description must carry parameter meaning. It does explain the tricky limit/offset interplay (limit=0 default returns everything, bounded pages yield next_offset), but leaves path, recursive and engagement_id entirely undefined in prose. Partial compensation only.

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 gives a specific verb and resource ("List files within the OpenCyber engagement workspace"), which separates it from the mutating siblings oc_workspace_read/write/delete. It does not explicitly say how it differs from other list tools such as oc_result_list, so it stops short of 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 Guidelines3/5

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

Usage context is implied by "within the OpenCyber engagement workspace" plus the note that limit=0 returns every entry, which hints at when to page versus fetch all. However, there is no explicit when-not guidance, no statement about when recursive or a specific path should be used, and no named alternative.

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

Deploy Server

Other Tools