TTMSMCPToolPropertyType Enumeration

Data type of a tool input property or of a tool return value. Each value maps onto the JSON Schema type emitted in the tool descriptor: ptInteger becomes integer, ptString becomes string, ptFloat becomes number, ptBoolean becomes boolean, ptDateTime becomes a string with format: date-time carrying an ISO 8601 timestamp, and ptJSON and ptObject both become object (ptObject can additionally expand into a full nested schema derived from the class the property names). ptArrayOfObjects, ptArrayOfStrings, ptArrayOfIntegers, ptArrayOfFloats and ptArrayOfBooleans all become array with an items type of object, string, integer, number and boolean respectively.

API unit family: TMS.MCP.Helpers

Members

Name	Description
ptInteger	Whole number. Published as JSON Schema type integer, and an incoming value that is not a JSON number is rejected.
ptString	Text. Published as JSON Schema type string. It is also the fallback for values that have no richer representation, so a non-string JSON value is accepted and converted to its text form rather than rejected.
ptFloat	Floating-point number. Published as JSON Schema type number, and an incoming value that is not a JSON number is rejected.
ptBoolean	Two-state value. Published as JSON Schema type boolean, and an incoming value that is not a JSON boolean is rejected.
ptDateTime	Point in time. Published as a string carrying format: date-time, and the incoming value must be an ISO 8601 timestamp, which is converted to a date/time value.
ptJSON	Arbitrary JSON passed through untouched. Published as JSON Schema type object, and the incoming value is handed to the callback as the original JSON value rather than being converted. Chosen automatically for a parameter whose type descends from a JSON value class.
ptObject	Structured object. Published as JSON Schema type object, and it expands into a full nested schema derived from the class or record the parameter names when that type is known. Like raw JSON, the incoming value reaches the callback as the original JSON value.
ptArrayOfObjects	List of structured objects. Published as array with an items type of object, whose member fields come from the item-property collection declared on the parameter.
ptArrayOfStrings	List of text values. Published as array with an items type of string and converted to a dynamic array of strings.
ptArrayOfIntegers	List of whole numbers. Published as array with an items type of integer and converted to a dynamic array of integers.
ptArrayOfFloats	List of floating-point numbers. Published as array with an items type of number and converted to a dynamic array of doubles.
ptArrayOfBooleans	List of two-state values. Published as array with an items type of boolean and converted to a dynamic array of booleans.