Skip to main content
Glama
Nelson-PROIA

freebox-mcp

by Nelson-PROIA
OverviewSchemaSourceRelated ServersScoreDiscussionsAdmin
Python
Local

put_storage_disk_id_format

Format a disk by ID, erasing all data and creating a single partition using the full disk space. Monitor progress via the disk's operation_pct field.

Instructions

Format the disk with the given id To be able to format a disk you need to provide the following parameters (JSON encoded). There will be one partition using all the available space on disk. All previous data will be lost. This parameters will be ignored if you format the Freebox internal disk NOTE: once started you can monitor the format process getting the disk information (see StorageDisk operation_pct field)

Error codes: not_found, invalid_disk, is_a_partition, is_internal, op_not_supported, op_failed, disk_busy

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
id__pathYes(Path parameter)
idNothe disk id
typeNoValues: `internal`: Freebox internal disk; `usb`: usb disk; `sata`: sata disk
stateNoValues: `error`: Disk has error; `disabled`: Disk is disabled; `enabled`: Disk is enabled; `formatting`: Disk is formatting
connectorNoDisk physical connector id
total_bytesNoDisk size (in bytes)
table_typeNo
modelNoDisk model
serialNoDisk serial number
firmwareNoDisk firmware version
tempNoDisk temperature (when supported) in °C
operation_pctNopartition operation progress
partitionsNolist of disk partitions
idleNois disk idle (when available)
idle_durationNodisk idle duration (in seconds) (when available)
spinningNois disk spinning (when available)
active_durationNodisk activity duration (in seconds) (when available)
time_before_spindownNoseconds left before disk spin down (in seconds) (when available)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.1
    • changedInput schema / properties / id__path / type
      Previous value: -"integer"New value: +"string"
  2. Changed21 schema fields changed
    • addedInput schema / properties / active_duration
      Added value: +{
+  "description": "disk activity duration (in seconds) (when available)",
+  "type": "integer"
+}
    • removedInput schema / properties / body
      Removed value: -{
-  "additionalProperties": true,
-  "type": "object"
-}
    • addedInput schema / properties / connector
      Added value: +{
+  "description": "Disk physical connector id",
+  "type": "integer"
+}
    • addedInput schema / properties / firmware
      Added value: +{
+  "description": "Disk firmware version",
+  "type": "string"
+}
    • changedInput schema / properties / id / description
      Previous value: -"the disk id to format"New value: +"the disk id"
    • addedInput schema / properties / id__path
      Added value: +{
+  "description": "(Path parameter)",
+  "type": "integer"
+}
    • addedInput schema / properties / idle
      Added value: +{
+  "description": "is disk idle (when available)",
+  "type": "boolean"
+}
    • addedInput schema / properties / idle_duration
      Added value: +{
+  "description": "disk idle duration (in seconds) (when available)",
+  "type": "integer"
+}
    • addedInput schema / properties / model
      Added value: +{
+  "description": "Disk model",
+  "type": "string"
+}
    • addedInput schema / properties / operation_pct
      Added value: +{
+  "description": "partition operation progress",
+  "properties": {
+    "done_steps": {
+      "description": "number of steps done",
+      "type": "integer"
+    },
+    "max_steps": {
+      "description": "total number of steps",
+      "type": "integer"
+    },
+    "percent": {
+      "description": "current step progress",
+      "type": "integer"
+    }
+  },
+  "type": "object"
+}
    • addedInput schema / properties / partitions
      Added value: +{
+  "description": "list of disk partitions",
+  "items": {
+    "description": "Disk partitions have the following attributes:",
+    "properties": {
+      "disk_id": {
+        "description": "related disk id",
+        "type": "integer"
+      },
+      "free_bytes": {
+        "description": "partition free space (in bytes)",
+        "type": "integer"
+      },
+      "fsck_result": {
+        "description": "fsck result — Values: `no_run_yet`: Partition has not been checked yet; `running`: Check is in progress; `fs_clean`: File system is ok; `fs_corrected`: File system was corrected; `fs_needs_correction`: File system need correction; `failed`: File system has unrecoverable error",
+        "enum": [
+          "no_run_yet",
+          "running",
+          "fs_clean",
+          "fs_corrected",
+          "fs_needs_correction",
+          "failed"
+        ],
+        "type": "string"
+      },
+      "fstype": {
+        "enum": [
+          "empty",
+          "unknown",
+          "xfs",
+          "ext4",
+          "vfat",
+          "ntf",
+          "hf",
+          "hfsplus",
+          "swap",
+          "exfat"
+        ],
+        "type": "string"
+      },
+      "id": {
+        "description": "unique partition id",
+        "type": "integer"
+      },
+      "label": {
+        "description": "partition name",
+        "type": "string"
+      },
+      "operation_pct": {
+        "description": "partition operation progress",
+        "properties": {
+          "done_steps": {
+            "description": "number of steps done",
+            "type": "integer"
+          },
+          "max_steps": {
+            "description": "total number of steps",
+            "type": "integer"
+          },
+          "percent": {
+            "description": "current step progress",
+            "type": "integer"
+          }
+        },
+        "type": "object"
+      },
+      "path": {
+        "description": "partition mount point (encoded in base64 as explained in fs API)",
+        "type": "string"
+      },
+      "state": {
+        "description": "Values: `error`: Partition has error; `checking`: Partition check in progress; `formatting`: Partition format in progress; `mounting`: Partition mount in progress; `maintenance`: Partition is in maintenance mode; `mounted`: Partition is ready; `umounting`: Partition umount in progress; `umounted`: Partition is umounted; `ejecting`: Partition ejection in progress",
+        "enum": [
+          "error",
+          "checking",
+          "formatting",
+          "mounting",
+          "maintenance",
+          "mounted",
+          "umounting",
+          "umounted",
+          "ejecting"
+        ],
+        "type": "string"
+      },
+      "total_bytes": {
+        "description": "partition size (in bytes)",
+        "type": "integer"
+      },
+      "used_bytes": {
+        "description": "partition used space (in bytes)",
+        "type": "integer"
+      }
+    },
+    "type": "object"
+  },
+  "type": "array"
+}
    • addedInput schema / properties / serial
      Added value: +{
+  "description": "Disk serial number",
+  "type": "string"
+}
    • addedInput schema / properties / spinning
      Added value: +{
+  "description": "is disk spinning (when available)",
+  "type": "boolean"
+}
    • addedInput schema / properties / state
      Added value: +{
+  "description": "Values: `error`: Disk has error; `disabled`: Disk is disabled; `enabled`: Disk is enabled; `formatting`: Disk is formatting",
+  "enum": [
+    "error",
+    "disabled",
+    "enabled",
+    "formatting"
+  ],
+  "type": "string"
+}
    • addedInput schema / properties / table_type
      Added value: +{
+  "enum": [
+    "msdos",
+    "gpt",
+    "superfloppy",
+    "empty"
+  ],
+  "type": "integer"
+}
    • addedInput schema / properties / temp
      Added value: +{
+  "description": "Disk temperature (when supported) in °C",
+  "type": "integer"
+}
    • addedInput schema / properties / time_before_spindown
      Added value: +{
+  "description": "seconds left before disk spin down (in seconds) (when available)",
+  "type": "integer"
+}
    • addedInput schema / properties / total_bytes
      Added value: +{
+  "description": "Disk size (in bytes)",
+  "type": "integer"
+}
    • addedInput schema / properties / type
      Added value: +{
+  "description": "Values: `internal`: Freebox internal disk; `usb`: usb disk; `sata`: sata disk",
+  "enum": [
+    "internal",
+    "usb",
+    "sata"
+  ],
+  "type": "string"
+}
    • changedInput schema / required
      Previous value: -[
-  "id"
-]New value: +[
+  "id__path"
+]
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "additionalProperties": true,
+  "type": "object"
+}
  3. First observedv0.1.0

TDQS

A3.5/5.0
Behavior4/5

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

With no annotations, the description carries the full burden. It effectively discloses that all previous data will be lost, that monitoring is possible via the operation_pct field, and lists relevant error codes. This provides a clear behavioral picture for an irreversible operation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is somewhat run-on and could be better organized into sentences or bullet points. It includes all essential information but is not optimally concise or structured.

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?

Given the presence of an output schema, the description covers the key workflow (format, monitor, error codes). It lacks details on prerequisites (e.g., disk state before formatting) but is largely complete for the tool's purpose.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is high (94%), so baseline is 3. The description adds valuable context: parameter encoding (JSON) and the fact that parameters are ignored for internal disks. This goes beyond the schema's own descriptions.

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 'Format the disk with the given id' and explains that it creates a single partition and data is lost. However, it does not explicitly differentiate from sibling tools like put_storage_disk_id or put_storage_partition_id, leaving some ambiguity about when to use this specific tool.

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 lacks guidance on when to use this tool versus alternatives. It mentions prerequisites ('provide the following parameters') but does not specify when formatting is appropriate or when other storage tools should be used, leaving the agent without explicit decision-making cues.

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