FrameIO MCP Server

generate_entity

Generate FrameIO entity definition code with defineEntity() builder. Provide entity key, name, plural, description, and fields to create ready-to-use definitions.

Instructions

Generate entity definition code using defineEntity() builder

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": {
      "entityKey": "<entityKey>",
      "name": "<name>",
      "pluralName": "<pluralName>",
      "description": "<description>",
      "fields": "<fields>"
    },
    "name": "generate_entity"
  }
}

Input Schema

Name	Required	Description
`icon`	No	Lucide icon name (optional)
`name`	Yes	Singular entity name
`views`	No	View configurations (table, kanban, etc.)
`fields`	Yes	Array of field definitions
`entityKey`	Yes	Entity key in format {module-id}.{entity-name}
`pluralName`	Yes	Plural entity name
`description`	Yes	Entity description

Schema Changelog

Changes observed during successful MCP inspections.

First observedv1.0.0Sep 4, 2026

TDQS

C2.8/5.0

Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It only states that code is generated, but does not say whether this writes files, returns source text, mutates project state, or requires particular permissions. The mention of defineEntity() hints at the output style but gives no side-effect or safety profile.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single, front-loaded sentence with no filler words. It is appropriately brief for a one-line purpose statement, though it could easily have added usage or behavior context without becoming verbose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

This tool has 7 parameters, 5 required, no output schema, and no annotations, but the description offers no information about field structures, view configurations, icon semantics, or expected return format. An agent would lack critical guidance for correctly constructing a valid call.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema provides 100% coverage of all 7 parameters, so the baseline is 3. The description does not add parameter-level meaning beyond the schema, and the builder name gives only a slight hint about how parameters might be combined.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Description uses a specific verb ('Generate') and resource ('entity definition code') and names the builder 'defineEntity()', which is not a tautology. However, it does not explicitly distinguish itself from sibling tools like generate_module or generate_page, though 'entity' and the builder name provide clear differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is given on when to use this tool versus generate_module, validate_module, or other sibling generators by name. It also does not mention prerequisites, contexts (e.g., an existing module), or cases where another tool would be more appropriate.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.