Skip to main content
Glama
Sign In
Box MCP Server

Box MCP Server

by yandisa2005
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

box_metadata_update_instance_on_file_tool

Updates the metadata template instance on a file, setting values for specified fields and optionally removing fields omitted from the update.

Instructions

Update the metadata template instance associated with a specific file.

Args: ctx (Context): The context object containing the request and lifespan context. file_id (str): The ID of the file to update the metadata on. template_key (str): The key of the metadata template. metadata (dict): The metadata to update. remove_non_included_data (bool): If True, remove data from fields not included in the metadata.

Returns: dict: The response from the Box API after updating the metadata.

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": {
      "file_id": "<file_id>",
      "template_key": "<template_key>",
      "metadata": "<metadata>"
    },
    "name": "box_metadata_update_instance_on_file_tool"
  }
}

Input Schema

NameRequiredDescriptionDefault
file_idYes
metadataYes
template_keyYes
remove_non_included_dataNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.7.0

TDQS

C2.9/5.0
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It mentions that the tool updates metadata and can optionally remove non-included data, but doesn't cover critical aspects like required permissions, whether the update is idempotent, error conditions (e.g., invalid template key), or the structure of the API response. For a mutation tool with zero annotation coverage, this leaves significant gaps.

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 appropriately sized with a clear purpose statement followed by parameter explanations. The structure with 'Args:' and 'Returns:' sections is helpful, though the inclusion of 'ctx (Context)' in Args is unnecessary clutter since it's typically implicit in MCP tools.

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 mutation tool with 4 parameters, 0% schema description coverage, no annotations, and no output schema, the description is incomplete. It covers basic parameter semantics but lacks behavioral context (permissions, errors), usage guidance, and details on the response format, which are crucial for safe and effective tool invocation.

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 compensate. It lists all four parameters with brief explanations, adding meaning beyond the bare schema. However, it doesn't provide details on parameter formats (e.g., what a valid template_key looks like), constraints, or examples for the metadata dictionary structure, leaving some ambiguity.

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 verb 'update' and the resource 'metadata template instance associated with a specific file', making the purpose specific and understandable. However, it doesn't explicitly distinguish this tool from its metadata-related siblings like 'box_metadata_set_instance_on_file_tool' or 'box_metadata_get_instance_on_file_tool', which would require mentioning partial updates versus complete replacements or retrievals.

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. There's no mention of prerequisites (e.g., needing an existing metadata instance), comparison to sibling tools like 'set' or 'delete' metadata instances, or scenarios where this update operation is appropriate versus creating a new instance.

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