Get Define-XML Codelist
define_get_codelistRetrieve a specific codelist by name from a loaded Define-XML document, optionally including its terms. Use after loading a document to access codelist metadata.
Instructions
Get a single codelist by name from a loaded Define-XML document.
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": {
"document_id": "<document_id>",
"name": "<name>"
},
"name": "define_get_codelist"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Entity name identifier. | |
| document_id | Yes | ID returned by define_load_document. | |
| include_terms | No | When true, include codelist terms in response. | |
| response_format | No | Response format: 'json' or 'markdown'. | markdown |