@kintone/mcp-server 1.0.0 → 1.1.0

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,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 = {
     app: z
         .string()
@@ -10,6 +8,10 @@ const inputSchema = {
         .enum(["ja", "en", "zh", "default", "user"])
         .optional()
         .describe("The language for field names"),
+    preview: z
+        .boolean()
+        .optional()
+        .describe("Whether to get form fields from pre-live environment"),
 };
 const fieldPropertySchema = z.object({
     type: z.string().describe("The field type"),
@@ -113,17 +115,18 @@ const outputSchema = {
         .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",
     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 +141,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,43 @@
+import { z } from "zod";
+import { createTool } from "../../factory.js";
+import { layoutElementSchema } 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: z
+        .array(layoutElementSchema)
+        .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",
+    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);

package/dist/tools/kintone/app/get-process-management.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 = {
     app: z
         .string()
@@ -10,6 +8,10 @@ const inputSchema = {
         .enum(["ja", "en", "zh", "default", "user"])
         .optional()
         .describe("The language for field names"),
+    preview: z
+        .boolean()
+        .optional()
+        .describe("Whether to get process management settings from pre-live environment"),
 };
 const entitySchema = z.object({
     type: z.enum([
@@ -64,17 +66,18 @@ const outputSchema = {
         .describe("Array containing action configurations"),
     revision: z.string().describe("App settings revision number"),
 };
-export const getProcessManagement = createTool("kintone-get-process-management", {
+const toolName = "kintone-get-process-management";
+const toolConfig = {
     title: "Get Process Management",
     description: "Get process management settings from a kintone app",
     inputSchema,
     outputSchema,
-}, async ({ app, lang }) => {
-    const config = parseKintoneClientConfig();
-    const client = getKintoneClient(config);
+};
+const callback = async ({ app, lang, preview }, { client }) => {
     const response = await client.app.getProcessManagement({
         app,
         lang,
+        preview,
     });
     return {
         structuredContent: response,
@@ -85,4 +88,5 @@ export const getProcessManagement = createTool("kintone-get-process-management",
             },
         ],
     };
-});
+};
+export const getProcessManagement = createTool(toolName, toolConfig, callback);

package/dist/tools/kintone/file/download-file.js

@@ -0,0 +1,49 @@
+import { z } from "zod";
+import { ensureDirectoryExists, generateFileName, generateFilePath, getFileTypeFromArrayBuffer, writeFileSyncWithoutOverwrite, } from "../../../lib/filesystem.js";
+import { createTool } from "../../factory.js";
+const inputSchema = {
+    fileKey: z
+        .string()
+        .describe("The unique file key to download (obtained from record retrieval or file upload)"),
+    fileName: z
+        .string()
+        .describe("The filename (without extension) to use when downloading to local storage. The extension will be automatically detected and added based on the file's MIME type"),
+};
+const outputSchema = {
+    filePath: z.string().describe("Absolute path to the downloaded file"),
+    mimeType: z.string().describe("MIME type of the downloaded file"),
+    fileSize: z.number().describe("File size in bytes"),
+};
+const toolName = "kintone-download-file";
+const toolConfig = {
+    title: "Download File from Kintone",
+    description: "Download a file from kintone using its fileKey and save it to the configured download directory. Returns the absolute path to the saved file. Requires KINTONE_ATTACHMENTS_DIR environment variable to be set, app record viewing permission, and permission to view the field containing the file.",
+    inputSchema,
+    outputSchema,
+};
+const callback = async ({ fileKey, fileName }, { client, attachmentsDir }) => {
+    // Check if download directory is configured
+    if (!attachmentsDir) {
+        throw new Error("KINTONE_ATTACHMENTS_DIR environment variable must be set to use file download feature");
+    }
+    const buffer = await client.file.downloadFile({ fileKey });
+    ensureDirectoryExists(attachmentsDir);
+    const fileTypeResult = await getFileTypeFromArrayBuffer(buffer);
+    const filePath = generateFilePath(attachmentsDir, generateFileName(fileName, fileTypeResult?.ext));
+    writeFileSyncWithoutOverwrite(filePath, buffer);
+    const result = {
+        filePath,
+        mimeType: fileTypeResult?.mime || "application/octet-stream",
+        fileSize: buffer.byteLength,
+    };
+    return {
+        structuredContent: result,
+        content: [
+            {
+                type: "text",
+                text: JSON.stringify(result, null, 2),
+            },
+        ],
+    };
+};
+export const downloadFile = createTool(toolName, toolConfig, callback);

package/dist/tools/kintone/record/add-records.js

@@ -1,8 +1,6 @@
 import { z } from "zod";
-import { createTool } from "../../utils.js";
-import { getKintoneClient } from "../../../client.js";
-import { parseKintoneClientConfig } from "../../../config/index.js";
-import { recordSchemaForParameterWithoutFile } from "../../../schema/record/record-for-parameter.js";
+import { createTool } from "../../factory.js";
+import { recordSchemaForParameterWithoutFile } from "../../../schema/record/index.js";
 const inputSchema = {
     app: z
         .string()
@@ -19,14 +17,14 @@ const outputSchema = {
         .array(z.string())
         .describe("Array of revision numbers of the created records"),
 };
-export const addRecords = createTool("kintone-add-records", {
+const toolName = "kintone-add-records";
+const toolConfig = {
     title: "Add Records",
     description: "Add multiple records to a kintone app. Use kintone-get-form-fields tool first to discover available field codes and their required formats. Note: Some fields cannot be registered (LOOKUP copies, STATUS, CATEGORY, CALC, ASSIGNEE, auto-calculated fields).",
     inputSchema,
     outputSchema,
-}, async ({ app, records }) => {
-    const config = parseKintoneClientConfig();
-    const client = getKintoneClient(config);
+};
+const callback = async ({ app, records }, { client }) => {
     const response = await client.record.addRecords({
         app,
         records,
@@ -44,4 +42,5 @@ export const addRecords = createTool("kintone-add-records", {
             },
         ],
     };
-});
+};
+export const addRecords = createTool(toolName, toolConfig, callback);

package/dist/tools/kintone/record/delete-records.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 = {
     app: z.string().describe("The ID of the app (numeric value as string)"),
     ids: z
@@ -15,17 +13,18 @@ const inputSchema = {
         .describe("Array of expected revision numbers for each record (numeric values as strings). If specified, must have the same length as ids array. Deletion will fail if current revisions don't match. Specify -1 or omit to skip revision validation."),
 };
 const outputSchema = {};
-export const deleteRecords = createTool("kintone-delete-records", {
+const toolName = "kintone-delete-records";
+const toolConfig = {
     title: "Delete Records",
     description: "Delete multiple records from a kintone app. Maximum 100 records can be deleted at once.",
     inputSchema,
     outputSchema,
-}, async ({ app, ids, revisions }) => {
-    const config = parseKintoneClientConfig();
-    const client = getKintoneClient(config);
+};
+const callback = async ({ app, ids, revisions }, { client }) => {
     await client.record.deleteRecords({ app, ids, revisions });
     return {
         structuredContent: {},
         content: [],
     };
-});
+};
+export const deleteRecords = createTool(toolName, toolConfig, callback);

package/dist/tools/kintone/record/get-records.js

@@ -1,8 +1,6 @@
 import { z } from "zod";
-import { createTool } from "../../utils.js";
-import { getKintoneClient } from "../../../client.js";
-import { parseKintoneClientConfig } from "../../../config/index.js";
-import { recordSchema } from "../../../schema/record/records.js";
+import { createTool } from "../../factory.js";
+import { recordSchema } from "../../../schema/record/index.js";
 const filtersSchema = z
     .object({
     textContains: z
@@ -121,14 +119,14 @@ function buildQueryFromFilters(filters) {
     });
     return conditions.length > 0 ? conditions.join(" and ") : undefined;
 }
-export const getRecords = createTool("kintone-get-records", {
+const toolName = "kintone-get-records";
+const toolConfig = {
     title: "Get Records",
     description: "Get multiple records from a kintone app with structured filtering. Use kintone-get-form-fields tool first to discover available fields and their types.",
     inputSchema,
     outputSchema,
-}, async ({ app, filters, fields, orderBy, limit, offset }) => {
-    const config = parseKintoneClientConfig();
-    const client = getKintoneClient(config);
+};
+const callback = async ({ app, filters, fields, orderBy, limit, offset }, { client }) => {
     let query = filters ? buildQueryFromFilters(filters) : undefined;
     if (orderBy && orderBy.length > 0) {
         const orderClauses = orderBy
@@ -163,4 +161,5 @@ export const getRecords = createTool("kintone-get-records", {
             },
         ],
     };
-});
+};
+export const getRecords = createTool(toolName, toolConfig, callback);

package/dist/tools/kintone/record/update-records.js

@@ -1,8 +1,6 @@
 import { z } from "zod";
-import { createTool } from "../../utils.js";
-import { getKintoneClient } from "../../../client.js";
-import { parseKintoneClientConfig } from "../../../config/index.js";
-import { recordSchemaForParameter } from "../../../schema/record/record-for-parameter.js";
+import { createTool } from "../../factory.js";
+import { recordSchemaForParameter } from "../../../schema/record/index.js";
 const updateRecordSchema = z.object({
     // updateKey指定は対象外
     id: z.string().describe("Record ID to update (numeric value as string)"),
@@ -30,14 +28,14 @@ const outputSchema = {
     }))
         .describe("Array of updated record information"),
 };
-export const updateRecords = createTool("kintone-update-records", {
+const toolName = "kintone-update-records";
+const toolConfig = {
     title: "Update Records",
     description: "Update multiple records in a kintone app. Use kintone-get-form-fields tool first to discover available field codes and their required formats. Note: Some fields cannot be updated (LOOKUP copies, STATUS, CATEGORY, CALC, ASSIGNEE, auto-calculated fields).",
     inputSchema,
     outputSchema,
-}, async ({ app, records }) => {
-    const config = parseKintoneClientConfig();
-    const client = getKintoneClient(config);
+};
+const callback = async ({ app, records }, { client }) => {
     const response = await client.record.updateRecords({
         app,
         records,
@@ -55,4 +53,5 @@ export const updateRecords = createTool("kintone-update-records", {
             },
         ],
     };
-});
+};
+export const updateRecords = createTool(toolName, toolConfig, callback);

package/dist/tools/kintone/record/update-statuses.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 statusRecordSchema = z.object({
     id: z.string().describe("Record ID (numeric value as string)"),
     action: z
@@ -34,14 +32,14 @@ const outputSchema = {
     }))
         .describe("Array of updated record information"),
 };
-export const updateStatuses = createTool("kintone-update-statuses", {
+const toolName = "kintone-update-statuses";
+const toolConfig = {
     title: "Update Statuses",
     description: "Update status of multiple records in a kintone app. Requires process management feature to be enabled. Maximum 100 records can be updated at once.",
     inputSchema,
     outputSchema,
-}, async ({ app, records }) => {
-    const config = parseKintoneClientConfig();
-    const client = getKintoneClient(config);
+};
+const callback = async ({ app, records }, { client }) => {
     const response = await client.record.updateRecordsStatus({
         app,
         records,
@@ -58,4 +56,5 @@ export const updateStatuses = createTool("kintone-update-statuses", {
             },
         ],
     };
-});
+};
+export const updateStatuses = createTool(toolName, toolConfig, callback);

package/dist/tools/types/tool.js

@@ -0,0 +1 @@
+export {};

package/dist/version.js

@@ -1,2 +1,2 @@
 // This file is auto-generated. Do not edit manually.
-export const version = "1.0.0"; // x-release-please-version
+export const version = "1.1.0"; // x-release-please-version

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kintone/mcp-server",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "The official MCP Server for kintone",
   "keywords": [
     "kintone",
@@ -31,7 +31,8 @@
   ],
   "dependencies": {
     "@kintone/rest-api-client": "^5.7.4",
-    "@modelcontextprotocol/sdk": "^1.17.4",
+    "@modelcontextprotocol/sdk": "^1.17.5",
+    "file-type": "^21.0.0",
     "https-proxy-agent": "^7.0.6",
     "zod": "^3.25.76"
   },
@@ -41,10 +42,10 @@
     "@commitlint/config-conventional": "^19.8.1",
     "@cybozu/eslint-config": "^24.2.0",
     "@cybozu/license-manager": "^1.3.1",
-    "@types/node": "^22.18.0",
+    "@types/node": "^22.18.1",
     "doctoc": "^2.2.1",
-    "eslint": "^9.34.0",
-    "eslint-plugin-package-json": "^0.56.0",
+    "eslint": "^9.35.0",
+    "eslint-plugin-package-json": "^0.56.2",
     "globals": "^16.3.0",
     "prettier": "^3.6.2",
     "tsx": "^4.20.5",

package/dist/server.js

@@ -1,20 +0,0 @@
-import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
-import { tools } from "./tools/index.js";
-import { version } from "./version.js";
-import { PACKAGE_NAME, parseKintoneClientConfig } from "./config/index.js";
-import { shouldEnableTool } from "./tool-filters.js";
-export const createServer = () => {
-    const server = new McpServer({
-        name: PACKAGE_NAME,
-        version,
-    }, {
-        capabilities: {
-            tools: {},
-        },
-    });
-    const config = parseKintoneClientConfig();
-    tools
-        .filter((tool) => shouldEnableTool(tool.name, config))
-        .forEach((tool) => server.registerTool(tool.name, tool.config, tool.callback));
-    return server;
-};