productivity
Kintone CLI for AI Agents
Use the Kintone CLI from KosmoKrator to call Kintone tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.Kintone CLI Setup
Kintone can be configured headlessly with `kosmokrator integrations:configure kintone`.
# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash
# Configure and verify this integration.
kosmokrator integrations:configure kintone --set access_token="$KINTONE_ACCESS_TOKEN" --set domain="$KINTONE_DOMAIN" --enable --read allow --write ask --json
kosmokrator integrations:doctor kintone --json
kosmokrator integrations:status --json Credentials
Authentication type: Bearer token bearer_token. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.
| Key | Env var | Type | Required | Label |
|---|---|---|---|---|
access_token | KINTONE_ACCESS_TOKEN | Secret secret | yes | API Token |
domain | KINTONE_DOMAIN | Text string | yes | Kintone Domain |
Command Patterns
The generic command is stable across every integration. The provider shortcut is shorter for humans.
kosmo integrations:call kintone.kintone_list_records '{"app":1,"query":"example_query","fields":"example_fields","limit":1,"offset":1}' --json kosmo integrations:kintone kintone_list_records '{"app":1,"query":"example_query","fields":"example_fields","limit":1,"offset":1}' --json Discovery
These commands return structured output for coding agents that need to inspect capabilities before choosing a function.
kosmo integrations:docs kintone --json
kosmo integrations:docs kintone.kintone_list_records --json
kosmo integrations:schema kintone.kintone_list_records --json
kosmo integrations:search "Kintone" --json
kosmo integrations:list --json Automation Contexts
The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.
CLI Functions
Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.
kintone.kintone_list_records
Retrieve records from a Kintone app. Supports filtering with a query string, selecting specific fields, and pagination with limit/offset. Use this to search and list data stored in any Kintone app.
read - Parameters
- app, query, fields, limit, offset
kosmo integrations:call kintone.kintone_list_records '{"app":1,"query":"example_query","fields":"example_fields","limit":1,"offset":1}' --json kosmo integrations:kintone kintone_list_records '{"app":1,"query":"example_query","fields":"example_fields","limit":1,"offset":1}' --json kintone.kintone_get_record
Retrieve a single record from a Kintone app by its record ID. Returns all field values for the record.
read - Parameters
- app, id
kosmo integrations:call kintone.kintone_get_record '{"app":1,"id":1}' --json kosmo integrations:kintone kintone_get_record '{"app":1,"id":1}' --json kintone.kintone_create_record
Create a new record in a Kintone app. The record parameter is an object keyed by field codes, each containing a "value" property (e.g., {"Title": {"value": "Hello"}, "Number": {"value": 42}}).
write - Parameters
- app, record
kosmo integrations:call kintone.kintone_create_record '{"app":1,"record":"example_record"}' --json kosmo integrations:kintone kintone_create_record '{"app":1,"record":"example_record"}' --json kintone.kintone_list_apps
List available Kintone apps. Returns app IDs, names, and descriptions to help discover which apps are accessible.
read - Parameters
- limit, offset
kosmo integrations:call kintone.kintone_list_apps '{"limit":1,"offset":1}' --json kosmo integrations:kintone kintone_list_apps '{"limit":1,"offset":1}' --json kintone.kintone_get_app
Get details of a specific Kintone app, including its name, description, and settings.
read - Parameters
- id
kosmo integrations:call kintone.kintone_get_app '{"id":1}' --json kosmo integrations:kintone kintone_get_app '{"id":1}' --json kintone.kintone_list_spaces
List Kintone spaces. Spaces are collaborative workspaces that contain apps, threads, and other resources.
read - Parameters
- limit, offset
kosmo integrations:call kintone.kintone_list_spaces '{"limit":1,"offset":1}' --json kosmo integrations:kintone kintone_list_spaces '{"limit":1,"offset":1}' --json kintone.kintone_get_current_user
Get the profile of the currently authenticated Kintone user, including name, email, and user settings.
read - Parameters
- none
kosmo integrations:call kintone.kintone_get_current_user '{}' --json kosmo integrations:kintone kintone_get_current_user '{}' --json Function Schemas
Use these parameter tables when building CLI payloads without calling integrations:schema first.
kintone.kintone_list_records 5 parameters
kosmo integrations:schema kintone.kintone_list_records --json | Parameter | Type | Required | Description |
|---|---|---|---|
app | integer | yes | The app ID. |
query | string | no | Kintone query string to filter records (e.g., "Status = \"Open\" order by Record_number asc"). |
fields | array | no | List of field codes to include in the response. Omit to return all fields. |
limit | integer | no | Maximum number of records to return (max 500, default 100). |
offset | integer | no | Number of records to skip for pagination. |
kintone.kintone_get_record 2 parameters
kosmo integrations:schema kintone.kintone_get_record --json | Parameter | Type | Required | Description |
|---|---|---|---|
app | integer | yes | The app ID. |
id | integer | yes | The record ID. |
kintone.kintone_create_record 2 parameters
kosmo integrations:schema kintone.kintone_create_record --json | Parameter | Type | Required | Description |
|---|---|---|---|
app | integer | yes | The app ID. |
record | object | yes | Field values keyed by field code. Each key maps to {"value": ...}. Example: {"Title": {"value": "Hello"}, "Number": {"value": 42}}. |
kintone.kintone_list_apps 2 parameters
kosmo integrations:schema kintone.kintone_list_apps --json | Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Maximum number of apps to return (default 100, max 500). |
offset | integer | no | Number of apps to skip for pagination. |
kintone.kintone_get_app 1 parameters
kosmo integrations:schema kintone.kintone_get_app --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | integer | yes | The app ID. |
kintone.kintone_list_spaces 2 parameters
kosmo integrations:schema kintone.kintone_list_spaces --json | Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Maximum number of spaces to return (default 100, max 500). |
offset | integer | no | Number of spaces to skip for pagination. |
kintone.kintone_get_current_user 0 parameters
kosmo integrations:schema kintone.kintone_get_current_user --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
Permissions
Headless calls still follow the integration read/write permission policy. Configure read/write defaults with
integrations:configure. Add --force only for trusted automation that should bypass that policy.