add_instrument
Add a new instrument (form) to your REDCap project by creating a placeholder field, which you can replace with real fields later.
Instructions
Add a new instrument (form) to the project.
Creates the instrument by inserting a placeholder descriptive field. REDCap requires at least one field per instrument; the placeholder can be removed later once real fields have been added via add_field.
Note: the instrument display label defaults to the prettified form_name and can only be changed in the REDCap UI (Designer → instrument name).
Args: form_name: Internal name for the instrument (lowercase, underscores, no spaces).
Returns: Confirmation message with the placeholder field name.
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": {
"form_name": "<form_name>"
},
"name": "add_instrument"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| form_name | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |