rename_instrument
Change an instrument's internal form name across all its fields in REDCap. The display label stays unchanged and must be updated separately in Designer.
Instructions
Rename an instrument by updating the form_name on all its fields.
Note: this changes the internal name only. The display label shown in the REDCap UI must be updated separately in Designer.
Args: old_form_name: Current internal name of the instrument. new_form_name: New internal name (lowercase, underscores, no spaces).
Returns: Confirmation message with the count of updated fields.
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": {
"old_form_name": "<old_form_name>",
"new_form_name": "<new_form_name>"
},
"name": "rename_instrument"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| new_form_name | Yes | ||
| old_form_name | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |