---
title: "Replace or shallow-merge an existing entity schema file"
method: POST
path: "/api/mcp/tools/update_entity_schema"
tags: ["tools"]
---

# Replace or shallow-merge an existing entity schema file

`POST /api/mcp/tools/update_entity_schema`

## Request

- Base URL: `https://finestructure.ai`
- URL: `https://finestructure.ai/api/mcp/tools/update_entity_schema`
- Auth: HTTP bearer

Replace or shallow-merge an existing entity schema file. Creates a Saved Version before writing.

## Request body

- object
  - `app_id` string, required: The app ID
  - `entity` string, required: Entity name
  - `schema` object, required: Schema fields to set or merge
  - `relationships` object[]
  - `indexes` object[]
  - `metadata` object
  - `merge` boolean

## Response `200`

Tool executed successfully

- ToolResult
  - `ok` boolean, required
  - `tool` string, required
  - `result` object, required

## Other responses

- `400`: Invalid arguments for this tool
- `401`: Missing or invalid bearer token
- `402`: Not enough credits on the account
- `403`: Token scope does not permit this tool
- `404`: Unknown tool name
- `429`: Rate limit exceeded, retry after the indicated delay
- `500`: Internal error while executing the tool

---

[API](https://skmtc.dev/finestructure/apis/fine-structure-api.md) · [All operations](https://skmtc.dev/finestructure/apis/fine-structure-api/llms.txt) · [OpenAPI document](https://skmtc.dev/finestructure/apis/fine-structure-api/revisions/02c50ed5fd70?raw)