Skip to main content
Glama
kintone

kintone MCP Server

Official
by kintone

Get Form Layout

kintone-get-form-layout

Retrieve the form layout structure of a kintone app to understand row, subtable, and field positioning. Use this before updating layouts or adding new fields.

Instructions

Get form layout from a kintone app. Returns layout structure with rows, subtables, groups, and field positioning. Use to understand current form arrangement before layout updates. Essential when adding new fields that need specific positioning or when rearranging existing fields. Supports both live and pre-live app settings retrieval.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
appYesThe ID of the app to retrieve form layout from (numeric value as string)
previewNoWhether to retrieve from preview environment (requires app administration permission for preview, record view/add permission for production)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
layoutYesArray of layout elements (rows, subtables, groups)
revisionYesApp configuration revision number
Behavior3/5

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

No annotations provided, so description must disclose key behaviors. The verb 'Get' implies read-only, but the description does not explicitly state it is non-destructive or safe. It mentions preview vs. live retrieval, adding some transparency, but falls short of full disclosure.

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

Conciseness5/5

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

Three sentences, front-loaded with purpose, and all content is relevant. No redundancy or wasted words.

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

Completeness4/5

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

Given the tool's complexity (2 params, simple boolean), the description covers purpose, return structure, and use cases. An output schema exists (not shown) but description adequately explains output content. Lacks mention of permissions or idempotency, but sufficient for its scope.

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

Parameters4/5

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

Schema coverage is 100%, so baseline is 3. The description adds value by contextualizing the preview parameter with 'Supports both live and pre-live app settings retrieval', which goes beyond the schema's boolean description.

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

Purpose5/5

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

The description clearly states the tool retrieves form layout from a kintone app, specifying return details ('rows, subtables, groups, field positioning'). It distinguishes from siblings like kintone-update-form-layout and kintone-add-form-fields by focusing on reading current layout.

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

Usage Guidelines4/5

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

The description explicitly guides when to use: 'before layout updates' and 'when adding new fields... rearranging existing fields'. It also mentions preview support. However, it lacks explicit when-not or direct comparison to kintone-get-form-fields as an alternative.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/kintone/mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server