kintone

The kintone MCP Server is your local MCP gateway to the kintone REST API. It lets you run and manage MCP-connected tools locally, enabling streamlined integration with kintone apps and data from your development environment.

How to use

Start by choosing how you want to run the MCP Server locally. You can run it via Docker, or install the npm package and start the server from the command line. Provide your kintone base URL and credentials to establish a secure connection. Once running, you can use the MCP client tools to fetch app data, manage forms, and automate common tasks against your kintone environment. Ensure your environment variables or command line flags match your kintone configuration for seamless authentication.

How to install

Prerequisites: you need Docker installed or Node.js with npm available.

Option A: Docker container (no local Node install required) run the container with your credentials and base URL.

docker run -i --rm \
  -e KINTONE_BASE_URL=https://example.cybozu.com \
  -e KINTONE_USERNAME=(username) \
  -e KINTONE_PASSWORD=(password) \
  ghcr.io/kintone/mcp-server

Option B: npm package (Node.js required)

Install the MCP Server globally and then start it with your credentials.

npm install -g @kintone/mcp-server

kintone-mcp-server \
  --base-url https://example.cybozu.com \
  --username (username) \
  --password (password)

Note: You may also provide credentials via environment variables KINTONE_BASE_URL, KINTONE_USERNAME, and KINTONE_PASSWORD. The values you pass on the command line take precedence over environment variables.

## Configuration file usage

If you prefer to configure MCP servers with a file, you can reference a configuration that wires a local, stdio-based MCP server. The configuration below shows how to run a docker-based MCP server via a managed command in a config file.

## Settings file example

{ "mcpServers": { "kintone": { "type": "stdio", "command": "docker", "args": [ "run", "-i", "--rm", "-e", "KINTONE_BASE_URL", "-e", "KINTONE_USERNAME", "-e", "KINTONE_PASSWORD", "ghcr.io/kintone/mcp-server:latest" ], "cwd": "${cwd}", "env": { "KINTONE_BASE_URL": "https://example.cybozu.com", "KINTONE_USERNAME": "username", "KINTONE_PASSWORD": "password" } } } }

## Available tools

### kintone-get-apps

Fetch multiple apps information from the kintone REST API.

### kintone-get-app

Fetch details for a single kintone app.

### kintone-get-form-fields

Retrieve an app's field definitions.

### kintone-get-form-layout

Retrieve an app's form layout.

### kintone-update-form-fields

Update an app's field definitions.

### kintone-update-form-layout

Update an app's form layout.

### kintone-delete-form-fields

Delete fields from an app.

### kintone-get-process-management

Fetch process management settings.

### kintone-get-app-deploy-status

Check deployment status of app configurations.

### kintone-get-general-settings

Retrieve an app's general settings.

### kintone-add-form-fields

Add fields to an app.

### kintone-get-records

Retrieve multiple records.

### kintone-add-records

Add multiple records.

### kintone-update-records

Update multiple records.

### kintone-delete-records

Delete multiple records.

### kintone-update-statuses

Update statuses for multiple records.

### kintone-add-app

Create an app in a test environment.

### kintone-deploy-app

Deploy app settings to production.

### kintone-update-general-settings

Modify general app settings.

### kintone-download-file

Download and save attachments from file fields.