Skip to main content
Glama
Sign In
Box MCP Server

Box MCP Server

by yandisa2005
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

box_metadata_set_instance_on_file_tool

Set metadata template values on a specific file to organize, classify, or retrieve it by custom attributes.

Instructions

Set a metadata template instance on a specific file.

Args: client (BoxClient): An authenticated Box client. template_key (str): The key of the metadata template to set. file_id (str): The ID of the file to set the metadata on. metadata (Dict[str, Any]): The metadata instance to set, as a dictionary. Metadata example: {'test_field': 'Test Value', 'date_field': '2023-10-01T00:00:00.000Z', 'float_field': 3.14, 'enum_field': 'option1', 'multiselect_field': ['option1', 'option2']}

Returns: dict: The response from the Box API after setting 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": {
      "template_key": "<template_key>",
      "file_id": "<file_id>",
      "metadata": "<metadata>"
    },
    "name": "box_metadata_set_instance_on_file_tool"
  }
}

Input Schema

NameRequiredDescriptionDefault
file_idYes
metadataYes
template_keyYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.7.0

TDQS

B3.3/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 states this is a 'Set' operation which implies mutation/writing, but doesn't mention authentication requirements, permissions needed, whether this overwrites existing metadata, error conditions, or rate limits. The metadata example provides some behavioral context but doesn't fully compensate for the lack of annotations.

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 well-structured with clear sections (Args, Returns) and front-loads the core purpose. The metadata example is appropriately detailed but could be more concise. Overall, most sentences earn their place, though the example could be summarized more efficiently.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with 3 parameters, 0% schema coverage, no annotations, and no output schema, the description provides adequate but incomplete coverage. The parameter explanations and example are helpful, but missing behavioral context (permissions, overwrite behavior, error handling) and return value details leaves gaps for an agent to use this tool effectively.

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?

With 0% schema description coverage, the description must compensate - and it does well by providing clear parameter explanations and a comprehensive metadata example showing field types and formats. The example demonstrates string, date, float, enum, and multiselect field types, adding significant value beyond the basic schema. However, it doesn't explain template_key format or file_id sourcing.

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 'Set' and the resource 'metadata template instance on a specific file', making the purpose explicit. It distinguishes from siblings like box_metadata_update_instance_on_file_tool and box_metadata_delete_instance_on_file_tool by specifying this is for setting/creating metadata instances rather than updating or deleting them.

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?

The description implies usage context through the parameter descriptions and metadata example, suggesting this tool is for applying metadata templates to files. However, it doesn't explicitly state when to use this versus alternatives like box_metadata_update_instance_on_file_tool or box_metadata_template_create_tool, nor does it mention prerequisites like needing an existing metadata template.

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