@kintone/mcp-server 1.0.0 → 1.2.0

package/dist/schema/app/field-properties.js

@@ -0,0 +1,330 @@
+import { z } from "zod";
+// サブテーブル内フィールド用の基本プロパティ（fieldsプロパティなし）
+const subtableFieldProperties = {
+    type: z
+        .string()
+        .describe("Field type (e.g., 'SINGLE_LINE_TEXT', 'NUMBER', 'DROP_DOWN', 'SUBTABLE')"),
+    code: z
+        .string()
+        .describe("Unique field identifier (max 128 chars, cannot start with number, only '_' allowed as special char)"),
+    label: z.string().describe("Display name for the field shown to users"),
+    noLabel: z
+        .boolean()
+        .optional()
+        .describe("If true, hides the field label in the form"),
+    required: z
+        .boolean()
+        .optional()
+        .describe("If true, field value is mandatory for record submission"),
+    unique: z
+        .boolean()
+        .optional()
+        .describe("If true, field value must be unique across all records"),
+    maxValue: z
+        .string()
+        .optional()
+        .describe("Maximum allowed value for numeric fields"),
+    minValue: z
+        .string()
+        .optional()
+        .describe("Minimum allowed value for numeric fields"),
+    maxLength: z
+        .string()
+        .optional()
+        .describe("Maximum character length for text fields"),
+    minLength: z
+        .string()
+        .optional()
+        .describe("Minimum character length for text fields"),
+    defaultValue: z
+        .any()
+        .optional()
+        .describe("Initial value when creating new records (use empty string '' for selection fields)"),
+    defaultNowValue: z
+        .boolean()
+        .optional()
+        .describe("If true, uses current date/time as default for DATE/TIME/DATETIME fields"),
+    entities: z
+        .array(z.object({
+        type: z.enum(["USER", "GROUP", "ORGANIZATION"]),
+        code: z.string(),
+    }))
+        .optional()
+        .describe("Default selected users/groups/departments for USER_SELECT/GROUP_SELECT/ORGANIZATION_SELECT fields"),
+    options: z
+        .record(z.object({
+        label: z
+            .string()
+            .describe("Display label (must exactly match the option key)"),
+        index: z
+            .string()
+            .describe("Index number as string, starting from 0 (e.g., '0', '1', '2')"),
+    }))
+        .optional()
+        .describe("Options for selection fields (DROP_DOWN, RADIO_BUTTON, CHECK_BOX, MULTI_SELECT). IMPORTANT: Option keys must exactly match their corresponding label values. For Japanese environments, use Japanese characters as keys, not English identifiers. Example: {'営業部': {'label': '営業部', 'index': '0'}}"),
+    align: z
+        .enum(["HORIZONTAL", "VERTICAL"])
+        .optional()
+        .describe("Layout direction for RADIO_BUTTON/CHECK_BOX options (HORIZONTAL: side by side, VERTICAL: stacked)"),
+    expression: z
+        .string()
+        .optional()
+        .describe("Formula for CALC fields (e.g., 'price * quantity')"),
+    hideExpression: z
+        .boolean()
+        .optional()
+        .describe("If true, hides the calculation formula from users in CALC fields"),
+    format: z
+        .string()
+        .optional()
+        .describe("Display format for NUMBER/CALC fields (e.g., 'NUMBER', 'NUMBER_DIGIT', 'DECIMAL', 'CURRENCY')"),
+    displayScale: z
+        .string()
+        .optional()
+        .describe("Number of decimal places to display for NUMBER/CALC fields"),
+    unit: z
+        .string()
+        .optional()
+        .describe("Unit text to display with NUMBER fields (e.g., '円', 'USD', 'kg')"),
+    unitPosition: z
+        .enum(["BEFORE", "AFTER"])
+        .optional()
+        .describe("Where to display unit text relative to the value (BEFORE: '$100', AFTER: '100円')"),
+    digit: z
+        .boolean()
+        .optional()
+        .describe("If true, displays thousands separator in NUMBER/CALC fields (e.g., 1,000)"),
+    thumbnailSize: z
+        .string()
+        .optional()
+        .describe("Thumbnail size for FILE field previews (in pixels, e.g., '150')"),
+    protocol: z
+        .enum(["WEB", "CALL", "MAIL"])
+        .optional()
+        .describe("Protocol for LINK fields (WEB: http/https links, CALL: tel: links, MAIL: mailto: links)"),
+    lookup: z
+        .object({
+        relatedApp: z.object({
+            app: z.string().describe("ID of the related app"),
+            code: z.string().describe("Code of the related app"),
+        }),
+        relatedKeyField: z
+            .string()
+            .describe("Field code in related app to match against"),
+        fieldMappings: z
+            .array(z.object({
+            field: z.string().describe("Field code in current app"),
+            relatedField: z
+                .string()
+                .describe("Field code in related app to copy value from"),
+        }))
+            .describe("Mapping of fields to copy from related app"),
+        lookupPickerFields: z
+            .array(z.string())
+            .describe("Fields to display in lookup picker"),
+        filterCond: z
+            .string()
+            .optional()
+            .describe("Query condition to filter lookup results"),
+        sort: z.string().optional().describe("Sort order for lookup results"),
+    })
+        .optional()
+        .describe("Lookup configuration to retrieve values from related app records"),
+    referenceTable: z
+        .object({
+        relatedApp: z.object({
+            app: z.string().describe("ID of the related app"),
+            code: z.string().describe("Code of the related app"),
+        }),
+        condition: z.object({
+            field: z.string().describe("Field code in current app to match"),
+            relatedField: z
+                .string()
+                .describe("Field code in related app to match against"),
+        }),
+        filterCond: z
+            .string()
+            .optional()
+            .describe("Additional filter condition for related records"),
+        displayFields: z
+            .array(z.string())
+            .describe("Fields from related app to display in the table"),
+        sort: z.string().optional().describe("Sort order for related records"),
+        size: z
+            .string()
+            .optional()
+            .describe("Number of records to display per page"),
+    })
+        .optional()
+        .describe("Configuration for REFERENCE_TABLE field to display related app records"),
+    openGroup: z
+        .boolean()
+        .optional()
+        .describe("If true, GROUP field is expanded by default when viewing records"),
+};
+export const baseFieldProperties = {
+    type: z
+        .string()
+        .describe("Field type (e.g., 'SINGLE_LINE_TEXT', 'NUMBER', 'DROP_DOWN', 'SUBTABLE')"),
+    code: z
+        .string()
+        .describe("Unique field identifier (max 128 chars, cannot start with number, only '_' allowed as special char)"),
+    label: z.string().describe("Display name for the field shown to users"),
+    noLabel: z
+        .boolean()
+        .optional()
+        .describe("If true, hides the field label in the form"),
+    required: z
+        .boolean()
+        .optional()
+        .describe("If true, field value is mandatory for record submission"),
+    unique: z
+        .boolean()
+        .optional()
+        .describe("If true, field value must be unique across all records"),
+    maxValue: z
+        .string()
+        .optional()
+        .describe("Maximum allowed value for numeric fields"),
+    minValue: z
+        .string()
+        .optional()
+        .describe("Minimum allowed value for numeric fields"),
+    maxLength: z
+        .string()
+        .optional()
+        .describe("Maximum character length for text fields"),
+    minLength: z
+        .string()
+        .optional()
+        .describe("Minimum character length for text fields"),
+    defaultValue: z
+        .any()
+        .optional()
+        .describe("Initial value when creating new records (use empty string '' for selection fields)"),
+    defaultNowValue: z
+        .boolean()
+        .optional()
+        .describe("If true, uses current date/time as default for DATE/TIME/DATETIME fields"),
+    entities: z
+        .array(z.object({
+        type: z.enum(["USER", "GROUP", "ORGANIZATION"]),
+        code: z.string(),
+    }))
+        .optional()
+        .describe("Default selected users/groups/departments for USER_SELECT/GROUP_SELECT/ORGANIZATION_SELECT fields"),
+    options: z
+        .record(z.object({
+        label: z
+            .string()
+            .describe("Display label (must exactly match the option key)"),
+        index: z
+            .string()
+            .describe("Index number as string, starting from 0 (e.g., '0', '1', '2')"),
+    }))
+        .optional()
+        .describe("Options for selection fields (DROP_DOWN, RADIO_BUTTON, CHECK_BOX, MULTI_SELECT). IMPORTANT: Option keys must exactly match their corresponding label values. For Japanese environments, use Japanese characters as keys, not English identifiers. Example: {'営業部': {'label': '営業部', 'index': '0'}}"),
+    align: z
+        .enum(["HORIZONTAL", "VERTICAL"])
+        .optional()
+        .describe("Layout direction for RADIO_BUTTON/CHECK_BOX options (HORIZONTAL: side by side, VERTICAL: stacked)"),
+    expression: z
+        .string()
+        .optional()
+        .describe("Formula for CALC fields (e.g., 'price * quantity')"),
+    hideExpression: z
+        .boolean()
+        .optional()
+        .describe("If true, hides the calculation formula from users in CALC fields"),
+    format: z
+        .string()
+        .optional()
+        .describe("Display format for NUMBER/CALC fields (e.g., 'NUMBER', 'NUMBER_DIGIT', 'DECIMAL', 'CURRENCY')"),
+    displayScale: z
+        .string()
+        .optional()
+        .describe("Number of decimal places to display for NUMBER/CALC fields"),
+    unit: z
+        .string()
+        .optional()
+        .describe("Unit text to display with NUMBER fields (e.g., '円', 'USD', 'kg')"),
+    unitPosition: z
+        .enum(["BEFORE", "AFTER"])
+        .optional()
+        .describe("Where to display unit text relative to the value (BEFORE: '$100', AFTER: '100円')"),
+    digit: z
+        .boolean()
+        .optional()
+        .describe("If true, displays thousands separator in NUMBER/CALC fields (e.g., 1,000)"),
+    thumbnailSize: z
+        .string()
+        .optional()
+        .describe("Thumbnail size for FILE field previews (in pixels, e.g., '150')"),
+    protocol: z
+        .enum(["WEB", "CALL", "MAIL"])
+        .optional()
+        .describe("Protocol for LINK fields (WEB: http/https links, CALL: tel: links, MAIL: mailto: links)"),
+    lookup: z
+        .object({
+        relatedApp: z.object({
+            app: z.string().describe("ID of the related app"),
+            code: z.string().describe("Code of the related app"),
+        }),
+        relatedKeyField: z
+            .string()
+            .describe("Field code in related app to match against"),
+        fieldMappings: z
+            .array(z.object({
+            field: z.string().describe("Field code in current app"),
+            relatedField: z
+                .string()
+                .describe("Field code in related app to copy value from"),
+        }))
+            .describe("Mapping of fields to copy from related app"),
+        lookupPickerFields: z
+            .array(z.string())
+            .describe("Fields to display in lookup picker"),
+        filterCond: z
+            .string()
+            .optional()
+            .describe("Query condition to filter lookup results"),
+        sort: z.string().optional().describe("Sort order for lookup results"),
+    })
+        .optional()
+        .describe("Lookup configuration to retrieve values from related app records"),
+    referenceTable: z
+        .object({
+        relatedApp: z.object({
+            app: z.string().describe("ID of the related app"),
+            code: z.string().describe("Code of the related app"),
+        }),
+        condition: z.object({
+            field: z.string().describe("Field code in current app to match"),
+            relatedField: z
+                .string()
+                .describe("Field code in related app to match against"),
+        }),
+        filterCond: z
+            .string()
+            .optional()
+            .describe("Additional filter condition for related records"),
+        displayFields: z
+            .array(z.string())
+            .describe("Fields from related app to display in the table"),
+        sort: z.string().optional().describe("Sort order for related records"),
+        size: z
+            .string()
+            .optional()
+            .describe("Number of records to display per page"),
+    })
+        .optional()
+        .describe("Configuration for REFERENCE_TABLE field to display related app records"),
+    fields: z
+        .record(z.string(), z.object(subtableFieldProperties))
+        .optional()
+        .describe("Fields in subtable. For SUBTABLE type, define the fields that will be contained within the table. Each key should be the field code, and the value should be the field properties"),
+    openGroup: z
+        .boolean()
+        .optional()
+        .describe("If true, GROUP field is expanded by default when viewing records"),
+};

package/dist/schema/app/form-layout.js

@@ -0,0 +1,105 @@
+import { z } from "zod";
+// フィールドタイプの定義
+const fieldTypeSchema = z.union([
+    z.literal("SINGLE_LINE_TEXT").describe("Text or Look-up field"),
+    z.literal("MULTI_LINE_TEXT").describe("Text Area field"),
+    z.literal("RICH_TEXT").describe("Rich text field"),
+    z.literal("NUMBER").describe("Number or Look-up field"),
+    z.literal("CALC").describe("Calculated field"),
+    z.literal("RADIO_BUTTON").describe("Radio button field"),
+    z.literal("CHECK_BOX").describe("Check box field"),
+    z.literal("MULTI_SELECT").describe("Multi-choice field"),
+    z.literal("DROP_DOWN").describe("Drop-down field"),
+    z.literal("USER_SELECT").describe("User selection field"),
+    z.literal("ORGANIZATION_SELECT").describe("Department selection field"),
+    z.literal("GROUP_SELECT").describe("Group selection field"),
+    z.literal("DATE").describe("Date field"),
+    z.literal("TIME").describe("Time field"),
+    z.literal("DATETIME").describe("Date and time field"),
+    z.literal("LINK").describe("Link field"),
+    z.literal("FILE").describe("Attachment field"),
+    z.literal("SUBTABLE").describe("Table field"),
+    z.literal("RECORD_NUMBER").describe("Record number field"),
+    z.literal("CREATOR").describe("Created by field"),
+    z.literal("CREATED_TIME").describe("Created datetime field"),
+    z.literal("MODIFIER").describe("Updated by field"),
+    z.literal("UPDATED_TIME").describe("Updated datetime field"),
+    z.literal("STATUS").describe("Process management status field"),
+    z
+        .literal("STATUS_ASSIGNEE")
+        .describe("Assignee of the Process Management status field"),
+    z.literal("CATEGORY").describe("Category field"),
+    z.literal("REFERENCE_TABLE").describe("Related Records field"),
+    z.literal("GROUP").describe("Field group"),
+    z.literal("LABEL").describe("Label field"),
+    z.literal("SPACER").describe("Blank space field"),
+    z.literal("HR").describe("Border field"),
+]);
+// サイズ設定スキーマ
+const sizeSchema = z
+    .object({
+    width: z
+        .union([z.string(), z.number()])
+        .optional()
+        .describe("Field width in pixels"),
+    height: z
+        .union([z.string(), z.number()])
+        .optional()
+        .describe("Field height (only applicable for specific fields like Blank space and Text Area)"),
+    innerHeight: z
+        .union([z.string(), z.number()])
+        .optional()
+        .describe("Inner height for multi-line text fields"),
+})
+    .optional()
+    .describe("Width and height configurations for fields");
+// パラメータ用のフィールドスキーマ
+const fieldForParameterSchema = z.object({
+    type: fieldTypeSchema.describe("The field type"),
+    code: z
+        .string()
+        .optional()
+        .describe("Field code (required for most field types except LABEL, SPACER, and HR). Must exactly match the existing field code in the app"),
+    label: z
+        .string()
+        .optional()
+        .describe("Text to set for Label fields (only used with Label field type)"),
+    elementId: z
+        .string()
+        .optional()
+        .describe("Element ID for Blank space fields (only used with Blank space field type)"),
+    size: sizeSchema,
+});
+// ROW レイアウトパラメータ
+const rowLayoutForParameterSchema = z.object({
+    type: z.literal("ROW").describe("A normal row of fields"),
+    fields: z
+        .array(fieldForParameterSchema)
+        .describe("List of field layouts in the row"),
+});
+// SUBTABLE レイアウトパラメータ
+const subtableLayoutForParameterSchema = z.object({
+    type: z.literal("SUBTABLE").describe("A Table"),
+    code: z
+        .string()
+        .describe("The field code of the SUBTABLE field (not individual fields inside)"),
+    fields: z
+        .array(fieldForParameterSchema)
+        .describe("List of field layouts INSIDE the subtable. These should be the field codes that exist within the subtable definition. Use kintone-get-form-fields to see the correct subtable structure. The subtable structure should be: {type: 'SUBTABLE', code: 'table_code', fields: [{type: 'TEXT', code: 'field_inside_table'}, ...]}"),
+});
+// GROUP レイアウトパラメータ
+const groupLayoutForParameterSchema = z.object({
+    type: z.literal("GROUP").describe("A Group field"),
+    code: z.string().describe("The field code of the Group field"),
+    layout: z
+        .array(z.lazy(() => rowLayoutForParameterSchema))
+        .describe("List of field layouts inside the Group field"),
+});
+// LayoutForParameter スキーマ
+export const layoutForParameterSchema = z
+    .array(z.union([
+    rowLayoutForParameterSchema,
+    subtableLayoutForParameterSchema,
+    groupLayoutForParameterSchema,
+]))
+    .describe("List of field layouts for the form");

package/dist/schema/app/index.js

@@ -0,0 +1,3 @@
+export { baseFieldProperties } from "./field-properties.js";
+export { layoutForParameterSchema } from "./form-layout.js";
+export { propertiesForParameterSchema } from "./properties-parameter.js";