Skip to main content
Glama
SheetForge MCP

SheetForge MCP

by iHeldan

set_worksheet_protection

Destructive

Enable or disable protection for a specified worksheet, with optional password and capability flags, to control allowed user actions in Excel.

Instructions

Enable or disable worksheet protection with optional capability flags.

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": {
      "filepath": "<filepath>",
      "sheet_name": "<sheet_name>"
    },
    "name": "set_worksheet_protection"
  }
}

Input Schema

NameRequiredDescriptionDefault
dry_runNo
enabledNo
optionsNo
filepathYesReuse supplied server path; NEVER prepend client cwd. Rooted: relative OK; unrooted stdio: absolute, ask if missing.
passwordNo
sheet_nameYes
include_changesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.14.0
    • addedInput schema / properties / filepath / description
      Added value: +"Reuse supplied server path; NEVER prepend client cwd. Rooted: relative OK; unrooted stdio: absolute, ask if missing."
  2. First observedv0.8.0

TDQS

C2.7/5.0
Behavior2/5

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

Annotations only declare destructiveHint=true, so the description carries most of the burden. It does not say that disabling strips existing protection from the sheet, whether a password is required to unprotect, what the capability flags actually govern, or that dry_run previews the effect.

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?

A single front-loaded sentence with no filler. It is tight, but the brevity comes at the cost of the missing detail noted elsewhere.

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?

For a 7-parameter mutating tool with a password field, a dry-run flag, and no output schema, the description is far too thin. An agent cannot tell what the tool returns, how protection interacts with an existing password, or what dry_run changes.

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

Parameters2/5

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

Schema description coverage is only 14% across 7 parameters, so the description must compensate and largely does not. 'Optional capability flags' gestures at the options object, but enabled, password, dry_run, and include_changes are left entirely to bare schema titles.

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?

States a specific verb+resource: enable or disable worksheet protection, plus the notion of capability flags. An agent can tell what the tool does, though it is not distinguished from the sibling get_worksheet_protection (the read counterpart).

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 when-to-use, when-not, or prerequisite guidance. It never points to get_worksheet_protection for inspecting current protection state, nor does it explain when dry_run should be used before a real change.

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