@kintone/mcp-server 1.0.0 → 1.2.0

package/dist/tools/index.js

@@ -5,16 +5,39 @@ import { updateRecords } from "./kintone/record/update-records.js";
 import { getApp } from "./kintone/app/get-app.js";
 import { getApps } from "./kintone/app/get-apps.js";
 import { getFormFields } from "./kintone/app/get-form-fields.js";
+import { getFormLayout } from "./kintone/app/get-form-layout.js";
+import { updateFormFields } from "./kintone/app/update-form-fields.js";
+import { updateFormLayout } from "./kintone/app/update-form-layout.js";
+import { deleteFormFields } from "./kintone/app/delete-form-fields.js";
 import { getProcessManagement } from "./kintone/app/get-process-management.js";
+import { getAppDeployStatus } from "./kintone/app/get-app-deploy-status.js";
+import { getGeneralSettings } from "./kintone/app/get-general-settings.js";
+import { addFormFields } from "./kintone/app/add-form-fields.js";
 import { updateStatuses } from "./kintone/record/update-statuses.js";
+import { addApp } from "./kintone/app/add-app.js";
+import { deployApp } from "./kintone/app/deploy-app.js";
+import { updateGeneralSettings } from "./kintone/app/update-general-settings.js";
+import { downloadFile } from "./kintone/file/download-file.js";
+export { createToolCallback } from "./factory.js";
 export const tools = [
     getApp,
     getApps,
     getFormFields,
+    getFormLayout,
+    updateFormFields,
+    updateFormLayout,
+    deleteFormFields,
     getProcessManagement,
+    getAppDeployStatus,
+    getGeneralSettings,
+    addFormFields,
     updateStatuses,
     addRecords,
     deleteRecords,
     getRecords,
     updateRecords,
+    addApp,
+    deployApp,
+    updateGeneralSettings,
+    downloadFile,
 ];

package/dist/tools/kintone/app/add-app.js

@@ -0,0 +1,40 @@
+import { z } from "zod";
+import { createTool } from "../../factory.js";
+const inputSchema = {
+    name: z
+        .string()
+        .max(64)
+        .describe("The name of the app to create (max 64 characters)"),
+    space: z
+        .number()
+        .optional()
+        .describe("The space ID where the app will be created"),
+};
+const outputSchema = {
+    app: z.string().describe("The ID of the created app"),
+    revision: z.string().describe("The revision number of the created app"),
+};
+const toolName = "kintone-add-app";
+const toolConfig = {
+    title: "Add App",
+    description: "Create a new app in the pre-live environment on kintone. The pre-live environment is a temporary storage area where app information is saved before deployment. To reflect changes to the production environment, execute the kintone-deploy-app tool after this tool.",
+    inputSchema,
+    outputSchema,
+};
+const callback = async ({ name, space }, { client }) => {
+    const app = await client.app.addApp({ name, space });
+    const result = {
+        app: app.app,
+        revision: app.revision,
+    };
+    return {
+        structuredContent: result,
+        content: [
+            {
+                type: "text",
+                text: JSON.stringify(result, null, 2),
+            },
+        ],
+    };
+};
+export const addApp = createTool(toolName, toolConfig, callback);

package/dist/tools/kintone/app/add-form-fields.js

@@ -0,0 +1,50 @@
+import { z } from "zod";
+import { createTool } from "../../factory.js";
+import { propertiesForParameterSchema } from "../../../schema/app/index.js";
+const inputSchema = {
+    app: z
+        .string()
+        .describe("The ID of the app to add fields to (numeric value as string)"),
+    properties: propertiesForParameterSchema.describe("Object containing field configurations to add"),
+    revision: z
+        .string()
+        .optional()
+        .describe("Expected app configuration revision number. If the specified revision number does not match the current app's revision, an error will occur and the update will not be performed. If not specified or set to '-1', the revision number will not be checked."),
+};
+const outputSchema = {
+    revision: z.string().describe("Updated app configuration revision number"),
+};
+const toolName = "kintone-add-form-fields";
+const toolConfig = {
+    title: "Add Form Fields",
+    description: "Add new fields to a kintone app (preview environment only). " +
+        "Requires App Management permissions. " +
+        "Field codes must be unique, max 128 chars, cannot start with numbers, and only '_' symbol allowed. " +
+        "For selection fields (DROP_DOWN/RADIO_BUTTON/CHECK_BOX/MULTI_SELECT), option keys must exactly match their label values. " +
+        "Options require 'label' and 'index' properties. " +
+        "For lookup fields, use appropriate field type (NUMBER for RECORD_NUMBER, SINGLE_LINE_TEXT for text fields). " +
+        "Use kintone-get-form-fields first to check existing fields. " +
+        "Changes require kintone-deploy-app to apply to live app.",
+    inputSchema,
+    outputSchema,
+};
+const callback = async ({ app, properties, revision }, { client }) => {
+    const response = await client.app.addFormFields({
+        app,
+        properties,
+        revision,
+    });
+    const result = {
+        revision: response.revision,
+    };
+    return {
+        structuredContent: result,
+        content: [
+            {
+                type: "text",
+                text: JSON.stringify(result, null, 2),
+            },
+        ],
+    };
+};
+export const addFormFields = createTool(toolName, toolConfig, callback);

package/dist/tools/kintone/app/delete-form-fields.js

@@ -0,0 +1,51 @@
+import { z } from "zod";
+import { createTool } from "../../factory.js";
+const inputSchema = {
+    app: z
+        .string()
+        .describe("The ID of the app to delete form fields from (numeric value as string)"),
+    fields: z
+        .array(z.string())
+        .min(1, "At least one field code is required")
+        .max(100, "Maximum 100 fields can be deleted at once")
+        .describe("Array of field codes to delete"),
+    revision: z
+        .string()
+        .optional()
+        .describe("Expected app configuration revision number. If the specified revision number does not match the current app's revision, an error will occur and the update will not be performed. If not specified or set to '-1', the revision number will not be checked."),
+};
+const outputSchema = {
+    revision: z.string().describe("The new revision number after deletion"),
+};
+const toolName = "kintone-delete-form-fields";
+const toolConfig = {
+    title: "Delete Form Fields",
+    description: "Delete form fields from a kintone app (preview environment only). " +
+        "Maximum 100 fields can be deleted at once. " +
+        "Cannot delete status, assignee, or category fields. " +
+        "Useful for recreating lookup fields when updates fail. " +
+        "Use kintone-get-form-fields first to verify field codes. " +
+        "Changes require kintone-deploy-app to apply to live app.",
+    inputSchema,
+    outputSchema,
+};
+const callback = async ({ app, fields, revision }, { client }) => {
+    const response = (await client.app.deleteFormFields({
+        app,
+        fields,
+        revision,
+    }));
+    const result = {
+        revision: response.revision,
+    };
+    return {
+        structuredContent: result,
+        content: [
+            {
+                type: "text",
+                text: JSON.stringify(result, null, 2),
+            },
+        ],
+    };
+};
+export const deleteFormFields = createTool(toolName, toolConfig, callback);

package/dist/tools/kintone/app/deploy-app.js

@@ -0,0 +1,48 @@
+import { z } from "zod";
+import { createTool } from "../../factory.js";
+const inputSchema = {
+    apps: z
+        .array(z.object({
+        app: z
+            .string()
+            .describe("The ID of the app to deploy (numeric value as string)"),
+        revision: z
+            .string()
+            .optional()
+            .describe("The expected revision number"),
+    }))
+        .min(1)
+        .max(300)
+        .describe("List of apps to deploy (minimum 1, maximum 300 apps)"),
+    revert: z
+        .boolean()
+        .optional()
+        .describe("If true, revert changes instead of deploying (default: false)"),
+};
+const outputSchema = {
+    message: z.string().describe("Deployment status message"),
+};
+const toolName = "kintone-deploy-app";
+const toolConfig = {
+    title: "Deploy App Settings",
+    description: "Deploy app settings from pre-live to production environment on kintone. " +
+        "This is an asynchronous API - use kintone-get-app-deploy-status tool to check deployment progress.",
+    inputSchema,
+    outputSchema,
+};
+const callback = async ({ apps, revert }, { client }) => {
+    await client.app.deployApp({ apps, revert });
+    const result = {
+        message: `Deployment initiated for ${apps.length} app(s). Use kintone-get-app-deploy-status tool to check progress.`,
+    };
+    return {
+        structuredContent: result,
+        content: [
+            {
+                type: "text",
+                text: JSON.stringify(result, null, 2),
+            },
+        ],
+    };
+};
+export const deployApp = createTool(toolName, toolConfig, callback);

package/dist/tools/kintone/app/get-app-deploy-status.js

@@ -0,0 +1,42 @@
+import { z } from "zod";
+import { createTool } from "../../factory.js";
+const inputSchema = {
+    apps: z
+        .array(z.union([z.string(), z.number()]))
+        .min(1, "At least one app ID is required")
+        .max(300, "Maximum 300 app IDs allowed")
+        .describe("Array of app IDs to check deploy status (maximum 300)"),
+};
+const deployStatusEnum = z.enum(["PROCESSING", "SUCCESS", "FAIL", "CANCEL"], {
+    description: "Deployment status: PROCESSING (in progress), SUCCESS (completed), FAIL (failed), CANCEL (canceled)",
+});
+const outputSchema = {
+    apps: z
+        .array(z.object({
+        app: z.string().describe("The app ID"),
+        status: deployStatusEnum.describe("The deployment status"),
+    }))
+        .describe("Array of app deploy statuses"),
+};
+const toolName = "kintone-get-app-deploy-status";
+const toolConfig = {
+    title: "Get App Deploy Status",
+    description: "Get app deploy status from kintone",
+    inputSchema,
+    outputSchema,
+};
+const callback = async ({ apps }, { client }) => {
+    const result = await client.app.getDeployStatus({
+        apps,
+    });
+    return {
+        structuredContent: result,
+        content: [
+            {
+                type: "text",
+                text: JSON.stringify(result, null, 2),
+            },
+        ],
+    };
+};
+export const getAppDeployStatus = createTool(toolName, toolConfig, callback);

package/dist/tools/kintone/app/get-app.js

@@ -1,7 +1,5 @@
 import { z } from "zod";
-import { createTool } from "../../utils.js";
-import { getKintoneClient } from "../../../client.js";
-import { parseKintoneClientConfig } from "../../../config/index.js";
+import { createTool } from "../../factory.js";
 const inputSchema = {
     appId: z
         .string()
@@ -37,14 +35,14 @@ const outputSchema = {
     })
         .describe("The modifier information"),
 };
-export const getApp = createTool("kintone-get-app", {
+const toolName = "kintone-get-app";
+const toolConfig = {
     title: "Get App",
     description: "Get app settings from kintone",
     inputSchema,
     outputSchema,
-}, async ({ appId }) => {
-    const config = parseKintoneClientConfig();
-    const client = getKintoneClient(config);
+};
+const callback = async ({ appId }, { client }) => {
     const app = await client.app.getApp({ id: appId });
     const result = {
         appId: app.appId,
@@ -67,4 +65,5 @@ export const getApp = createTool("kintone-get-app", {
             },
         ],
     };
-});
+};
+export const getApp = createTool(toolName, toolConfig, callback);

package/dist/tools/kintone/app/get-apps.js

@@ -1,7 +1,5 @@
 import { z } from "zod";
-import { createTool } from "../../utils.js";
-import { getKintoneClient } from "../../../client.js";
-import { parseKintoneClientConfig } from "../../../config/index.js";
+import { createTool } from "../../factory.js";
 const inputSchema = {
     ids: z
         .array(z.string())
@@ -70,14 +68,14 @@ const appSchema = z.object({
 const outputSchema = {
     apps: z.array(appSchema).describe("Array of app information"),
 };
-export const getApps = createTool("kintone-get-apps", {
+const toolName = "kintone-get-apps";
+const toolConfig = {
     title: "Get Apps",
     description: "Get multiple app settings from kintone",
     inputSchema,
     outputSchema,
-}, async ({ ids, codes, name, spaceIds, offset, limit }) => {
-    const config = parseKintoneClientConfig();
-    const client = getKintoneClient(config);
+};
+const callback = async ({ ids, codes, name, spaceIds, offset, limit }, { client }) => {
     const response = await client.app.getApps({
         ids,
         codes,
@@ -109,4 +107,5 @@ export const getApps = createTool("kintone-get-apps", {
             },
         ],
     };
-});
+};
+export const getApps = createTool(toolName, toolConfig, callback);

package/dist/tools/kintone/app/get-form-fields.js

@@ -1,7 +1,6 @@
 import { z } from "zod";
-import { createTool } from "../../utils.js";
-import { getKintoneClient } from "../../../client.js";
-import { parseKintoneClientConfig } from "../../../config/index.js";
+import { createTool } from "../../factory.js";
+import { propertiesForParameterSchema } from "../../../schema/app/index.js";
 const inputSchema = {
     app: z
         .string()
@@ -10,120 +9,33 @@ const inputSchema = {
         .enum(["ja", "en", "zh", "default", "user"])
         .optional()
         .describe("The language for field names"),
-};
-const fieldPropertySchema = z.object({
-    type: z.string().describe("The field type"),
-    code: z.string().describe("The field code"),
-    label: z.string().describe("The field name"),
-    enabled: z
-        .boolean()
-        .optional()
-        .describe("Whether the field is enabled (for STATUS and CATEGORY fields)"),
-    noLabel: z.boolean().optional().describe("Whether to hide the field name"),
-    required: z.boolean().optional().describe("Whether the field is required"),
-    unique: z.boolean().optional().describe("Whether the field must be unique"),
-    maxValue: z.string().optional().describe("Maximum value"),
-    minValue: z.string().optional().describe("Minimum value"),
-    maxLength: z.string().optional().describe("Maximum length"),
-    minLength: z.string().optional().describe("Minimum length"),
-    defaultValue: z.any().optional().describe("Default value"),
-    defaultNowValue: z
+    preview: z
         .boolean()
         .optional()
-        .describe("Whether to use current date/time as default"),
-    entities: z
-        .array(z.object({
-        type: z.enum(["USER", "GROUP", "ORGANIZATION"]),
-        code: z.string(),
-    }))
-        .optional()
-        .describe("Default entities for user/group/organization selection fields"),
-    options: z
-        .record(z.object({
-        label: z.string(),
-        index: z.string(),
-    }))
-        .optional()
-        .describe("Options for selection fields"),
-    align: z
-        .enum(["HORIZONTAL", "VERTICAL"])
-        .optional()
-        .describe("Option alignment for radio/checkbox fields"),
-    expression: z.string().optional().describe("Calculation formula"),
-    hideExpression: z
-        .boolean()
-        .optional()
-        .describe("Whether to hide the formula"),
-    format: z.string().optional().describe("Display format"),
-    displayScale: z.string().optional().describe("Number of decimal places"),
-    unit: z.string().optional().describe("Unit symbol"),
-    unitPosition: z
-        .enum(["BEFORE", "AFTER"])
-        .optional()
-        .describe("Unit position"),
-    digit: z.boolean().optional().describe("Whether to use thousands separator"),
-    thumbnailSize: z.string().optional().describe("Image thumbnail size"),
-    protocol: z
-        .enum(["WEB", "CALL", "MAIL"])
-        .optional()
-        .describe("Link protocol"),
-    lookup: z
-        .object({
-        relatedApp: z.object({
-            app: z.string(),
-            code: z.string(),
-        }),
-        relatedKeyField: z.string(),
-        fieldMappings: z.array(z.object({
-            field: z.string(),
-            relatedField: z.string(),
-        })),
-        lookupPickerFields: z.array(z.string()),
-        filterCond: z.string().optional(),
-        sort: z.string().optional(),
-    })
-        .optional()
-        .describe("Lookup settings"),
-    referenceTable: z
-        .object({
-        relatedApp: z.object({
-            app: z.string(),
-            code: z.string(),
-        }),
-        condition: z.object({
-            field: z.string(),
-            relatedField: z.string(),
-        }),
-        filterCond: z.string().optional(),
-        displayFields: z.array(z.string()),
-        sort: z.string().optional(),
-        size: z.string().optional(),
-    })
-        .optional()
-        .describe("Related records settings"),
-    fields: z.record(z.any()).optional().describe("Fields in subtable"),
-    openGroup: z
-        .boolean()
-        .optional()
-        .describe("Whether the group is expanded by default"),
-});
+        .describe("Whether to get form fields from pre-live environment"),
+};
 const outputSchema = {
-    properties: z
-        .record(fieldPropertySchema)
-        .describe("Object containing field configurations"),
+    properties: propertiesForParameterSchema.describe("Object containing field configurations"),
     revision: z.string().describe("App configuration revision number"),
 };
-export const getFormFields = createTool("kintone-get-form-fields", {
+const toolName = "kintone-get-form-fields";
+const toolConfig = {
     title: "Get Form Fields",
-    description: "Get form field settings from a kintone app",
+    description: "Get form field settings from a kintone app. " +
+        "Returns detailed field information including type, code, label, and all configuration settings " +
+        "(required status, default values, validation rules, options for selection fields, lookup configurations). " +
+        "Response includes 'properties' object with all fields and 'revision' string. " +
+        "Essential for understanding current field structure before add/update/delete operations. " +
+        "Use to verify lookup field configurations and field mappings. " +
+        "Supports both live and pre-live app settings retrieval.",
     inputSchema,
     outputSchema,
-}, async ({ app, lang }) => {
-    const config = parseKintoneClientConfig();
-    const client = getKintoneClient(config);
+};
+const callback = async ({ app, lang, preview }, { client }) => {
     const response = await client.app.getFormFields({
         app,
         lang,
+        preview,
     });
     const result = {
         properties: response.properties,
@@ -138,4 +50,5 @@ export const getFormFields = createTool("kintone-get-form-fields", {
             },
         ],
     };
-});
+};
+export const getFormFields = createTool(toolName, toolConfig, callback);

package/dist/tools/kintone/app/get-form-layout.js

@@ -0,0 +1,45 @@
+import { z } from "zod";
+import { createTool } from "../../factory.js";
+import { layoutForParameterSchema } from "../../../schema/app/index.js";
+const inputSchema = {
+    app: z
+        .string()
+        .describe("The ID of the app to retrieve form layout from (numeric value as string)"),
+    preview: z
+        .boolean()
+        .optional()
+        .describe("Whether to retrieve from preview environment (requires app administration permission for preview, record view/add permission for production)"),
+};
+const outputSchema = {
+    layout: layoutForParameterSchema.describe("Array of layout elements (rows, subtables, groups)"),
+    revision: z.string().describe("App configuration revision number"),
+};
+const callback = async ({ app, preview }, { client }) => {
+    const response = await client.app.getFormLayout({
+        app,
+        preview,
+    });
+    const result = {
+        layout: response.layout,
+        revision: response.revision,
+    };
+    return {
+        structuredContent: result,
+        content: [
+            {
+                type: "text",
+                text: JSON.stringify(result, null, 2),
+            },
+        ],
+    };
+};
+export const getFormLayout = createTool("kintone-get-form-layout", {
+    title: "Get Form Layout",
+    description: "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.",
+    inputSchema,
+    outputSchema,
+}, callback);

package/dist/tools/kintone/app/get-general-settings.js

@@ -0,0 +1,119 @@
+import { z } from "zod";
+import { createTool } from "../../factory.js";
+const inputSchema = {
+    app: z
+        .string()
+        .describe("The ID of the app to retrieve (numeric value as string)"),
+    lang: z
+        .enum(["ja", "en", "zh", "default", "user"])
+        .optional()
+        .describe("The language for retrieving the app name and description"),
+    preview: z
+        .boolean()
+        .optional()
+        .describe("Whether to retrieve from preview environment (requires app administration permission for preview, record view/add permission for production)"),
+};
+const outputSchema = {
+    name: z.string().describe("The app name"),
+    description: z.string().describe("The app description"),
+    icon: z
+        .object({
+        type: z.enum(["FILE", "PRESET"]).describe("The icon type"),
+        key: z.string().optional().describe("The icon key"),
+        file: z
+            .object({
+            contentType: z.string().describe("The content type of the file"),
+            fileKey: z.string().describe("The file key"),
+            name: z.string().describe("The file name"),
+            size: z.string().describe("The file size"),
+        })
+            .optional()
+            .describe("File information (only when type is FILE)"),
+    })
+        .describe("The app icon settings"),
+    theme: z
+        .enum([
+        "WHITE",
+        "CLIPBOARD",
+        "BINDER",
+        "PENCIL",
+        "CLIPS",
+        "RED",
+        "BLUE",
+        "GREEN",
+        "YELLOW",
+        "BLACK",
+    ])
+        .describe("The app theme"),
+    titleField: z
+        .object({
+        selectionMode: z
+            .enum(["AUTO", "MANUAL"])
+            .describe("Title field selection mode"),
+        code: z.string().optional().describe("Field code for manual selection"),
+    })
+        .describe("Record title field configuration"),
+    enableThumbnails: z.boolean().describe("Whether thumbnails are enabled"),
+    enableBulkDeletion: z
+        .boolean()
+        .describe("Whether bulk record deletion is enabled"),
+    enableComments: z.boolean().describe("Whether comments are enabled"),
+    enableDuplicateRecord: z
+        .boolean()
+        .describe("Whether record duplication is enabled"),
+    enableInlineRecordEditing: z
+        .boolean()
+        .describe("Whether inline record editing is enabled"),
+    numberPrecision: z
+        .object({
+        digits: z.string().describe("The number of digits (1 to 30)"),
+        decimalPlaces: z
+            .string()
+            .describe("The number of decimal places (0 to 10)"),
+        roundingMode: z
+            .enum(["HALF_EVEN", "UP", "DOWN"])
+            .describe("The rounding mode"),
+    })
+        .describe("The numeric calculation settings"),
+    firstMonthOfFiscalYear: z
+        .string()
+        .describe("The first month of the fiscal year (1-12)"),
+    revision: z.string().describe("The revision number"),
+};
+const toolName = "kintone-get-general-settings";
+const toolConfig = {
+    title: "Get General Settings",
+    description: "Get general settings of a kintone app",
+    inputSchema,
+    outputSchema,
+};
+const callback = async ({ app, lang, preview }, { client }) => {
+    const settings = await client.app.getAppSettings({ app, lang, preview });
+    console.log(settings);
+    const result = {
+        name: settings.name,
+        description: settings.description,
+        icon: settings.icon,
+        theme: settings.theme,
+        titleField: settings.titleField,
+        enableThumbnails: settings.enableThumbnails,
+        enableBulkDeletion: settings.enableBulkDeletion,
+        enableComments: settings.enableComments,
+        enableDuplicateRecord: settings.enableDuplicateRecord,
+        // @ts-ignore - enableInlineRecordEditing is not yet in the Kintone SDK types but exists in API response
+        enableInlineRecordEditing: settings.enableInlineRecordEditing,
+        numberPrecision: settings.numberPrecision,
+        firstMonthOfFiscalYear: settings.firstMonthOfFiscalYear,
+        revision: settings.revision,
+    };
+    return {
+        structuredContent: result,
+        content: [
+            {
+                type: "text",
+                text: JSON.stringify(result, null, 2),
+            },
+        ],
+    };
+};
+export const getGeneralSettings = createTool(toolName, toolConfig, callback);