describe_entity_type
Retrieve the active schema for an entity type to see its declared fields, required fields, and types. Use it before storing data to prevent unknown-field and missing-required-field errors.
Instructions
Return the full active schema for one entity_type: field_names, per-field type/required/description (field_summary), required_fields, schema_version, and the raw schema_definition. Call this before store when you know the entity_type but not its declared field shape, so the first store lands with zero unknown_fields and zero required_fields_missing warnings. Repair workflow: when a prior store or correct returned unknown_fields_count > 0 (or unknown_field: true), call describe_entity_type to see the declared fields, then re-store or correct the value into a declared field that fits; only add a new field (update_schema_incremental / register_schema, per the response hint) when no declared field fits. Read-only; no persistence side effects. Errors with InvalidParams when the entity_type has no active schema (use list_entity_types to discover types, or register_schema to create one). Scope note: describe prefers user scope (always passes the session user id), while update_schema_incremental defaults user_specific: false (global-only guard) — a type visible here may still return ERR_SCHEMA_SCOPE_MISMATCH on an unscoped incremental update; retry with user_specific matching details.found_scope, never register_schema for that code.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | No | ||
| entity_type | Yes |