Can I use ORCID as a CLI?

Yes. KosmoKrator exposes a ORCID CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose ORCID through MCP?

Yes. The KosmoKrator MCP gateway can expose selected ORCID tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are ORCID credentials stored?

ORCID credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for ORCID MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

data

ORCID CLI for AI Agents

Use the ORCID CLI from KosmoKrator to call ORCID tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

ORCID CLI Setup

ORCID can be configured headlessly with `kosmokrator integrations:configure orcid`.

Install, configure, and verify

# 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 orcid --enable --read allow --write ask --json
kosmokrator integrations:doctor orcid --json
kosmokrator integrations:status --json

Credentials

Authentication type: No credentials none. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

No credentials are required.

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

Generic CLI call

kosmo integrations:call orcid.orcid_search '{}' --json

Provider shortcut

kosmo integrations:orcid orcid_search '{}' --json

Discovery

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

Discovery commands

kosmo integrations:docs orcid --json
kosmo integrations:docs orcid.orcid_search --json
kosmo integrations:schema orcid.orcid_search --json
kosmo integrations:search "ORCID" --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.

CI Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status. Cron Jobs Schedule repeatable integration workflows from cron while keeping credentials in KosmoKrator config. Shell Scripts Call integration functions from shell scripts with stable JSON input and output. Headless Automation Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers. Coding Agents Let coding agents discover schemas and execute integration functions through CLI commands or MCP.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

`orcid.orcid_search`

Search the ORCID registry using Solr syntax.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_search '{}' --json

Shortcut

kosmo integrations:orcid orcid_search '{}' --json

`orcid.orcid_expanded_search`

Search ORCID and return expanded identity/affiliation fields.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_expanded_search '{}' --json

Shortcut

kosmo integrations:orcid orcid_expanded_search '{}' --json

`orcid.orcid_csv_search`

Search ORCID and return CSV output columns.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_csv_search '{}' --json

Shortcut

kosmo integrations:orcid orcid_csv_search '{}' --json

`orcid.orcid_record`

Read a full public ORCID record summary.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_record '{}' --json

Shortcut

kosmo integrations:orcid orcid_record '{}' --json

`orcid.orcid_person`

Read the public person section.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_person '{}' --json

Shortcut

kosmo integrations:orcid orcid_person '{}' --json

`orcid.orcid_personal_details`

Read public personal details.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_personal_details '{}' --json

Shortcut

kosmo integrations:orcid orcid_personal_details '{}' --json

`orcid.orcid_address`

Read public address/country data.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_address '{}' --json

Shortcut

kosmo integrations:orcid orcid_address '{}' --json

`orcid.orcid_keywords`

Read public keywords.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_keywords '{}' --json

Shortcut

kosmo integrations:orcid orcid_keywords '{}' --json

`orcid.orcid_external_identifiers`

Read public external identifiers.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_external_identifiers '{}' --json

Shortcut

kosmo integrations:orcid orcid_external_identifiers '{}' --json

`orcid.orcid_researcher_urls`

Read public researcher URLs.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_researcher_urls '{}' --json

Shortcut

kosmo integrations:orcid orcid_researcher_urls '{}' --json

`orcid.orcid_other_names`

Read public other names.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_other_names '{}' --json

Shortcut

kosmo integrations:orcid orcid_other_names '{}' --json

`orcid.orcid_activities`

Read public activities summary.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_activities '{}' --json

Shortcut

kosmo integrations:orcid orcid_activities '{}' --json

`orcid.orcid_works`

Read public works summary groups.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_works '{}' --json

Shortcut

kosmo integrations:orcid orcid_works '{}' --json

`orcid.orcid_work`

Read one public work by put code.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_work '{}' --json

Shortcut

kosmo integrations:orcid orcid_work '{}' --json

`orcid.orcid_employments`

Read public employment summaries.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_employments '{}' --json

Shortcut

kosmo integrations:orcid orcid_employments '{}' --json

`orcid.orcid_employment`

Read one public employment by put code.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_employment '{}' --json

Shortcut

kosmo integrations:orcid orcid_employment '{}' --json

`orcid.orcid_educations`

Read public education summaries.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_educations '{}' --json

Shortcut

kosmo integrations:orcid orcid_educations '{}' --json

`orcid.orcid_education`

Read one public education by put code.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_education '{}' --json

Shortcut

kosmo integrations:orcid orcid_education '{}' --json

`orcid.orcid_qualifications`

Read public qualification summaries.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_qualifications '{}' --json

Shortcut

kosmo integrations:orcid orcid_qualifications '{}' --json

`orcid.orcid_qualification`

Read one public qualification by put code.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_qualification '{}' --json

Shortcut

kosmo integrations:orcid orcid_qualification '{}' --json

`orcid.orcid_invited_positions`

Read public invited-position summaries.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_invited_positions '{}' --json

Shortcut

kosmo integrations:orcid orcid_invited_positions '{}' --json

`orcid.orcid_invited_position`

Read one public invited position by put code.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_invited_position '{}' --json

Shortcut

kosmo integrations:orcid orcid_invited_position '{}' --json

`orcid.orcid_distinctions`

Read public distinction summaries.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_distinctions '{}' --json

Shortcut

kosmo integrations:orcid orcid_distinctions '{}' --json

`orcid.orcid_distinction`

Read one public distinction by put code.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_distinction '{}' --json

Shortcut

kosmo integrations:orcid orcid_distinction '{}' --json

`orcid.orcid_memberships`

Read public membership summaries.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_memberships '{}' --json

Shortcut

kosmo integrations:orcid orcid_memberships '{}' --json

`orcid.orcid_membership`

Read one public membership by put code.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_membership '{}' --json

Shortcut

kosmo integrations:orcid orcid_membership '{}' --json

`orcid.orcid_services`

Read public service summaries.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_services '{}' --json

Shortcut

kosmo integrations:orcid orcid_services '{}' --json

`orcid.orcid_service`

Read one public service by put code.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_service '{}' --json

Shortcut

kosmo integrations:orcid orcid_service '{}' --json

`orcid.orcid_fundings`

Read public funding summaries.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_fundings '{}' --json

Shortcut

kosmo integrations:orcid orcid_fundings '{}' --json

`orcid.orcid_funding`

Read one public funding by put code.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_funding '{}' --json

Shortcut

kosmo integrations:orcid orcid_funding '{}' --json

`orcid.orcid_peer_reviews`

Read public peer-review summaries.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_peer_reviews '{}' --json

Shortcut

kosmo integrations:orcid orcid_peer_reviews '{}' --json

`orcid.orcid_peer_review`

Read one public peer review by put code.

Read read

Parameters: none

Generic call

kosmo integrations:call orcid.orcid_peer_review '{}' --json

Shortcut

kosmo integrations:orcid orcid_peer_review '{}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

orcid.orcid_search 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_search --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_expanded_search 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_expanded_search --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_csv_search 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_csv_search --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_record 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_record --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_person 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_person --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_personal_details 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_personal_details --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_address 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_address --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_keywords 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_keywords --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_external_identifiers 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_external_identifiers --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_researcher_urls 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_researcher_urls --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_other_names 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_other_names --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_activities 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_activities --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_works 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_works --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_work 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_work --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_employments 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_employments --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_employment 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_employment --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_educations 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_educations --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_education 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_education --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_qualifications 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_qualifications --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_qualification 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_qualification --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_invited_positions 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_invited_positions --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_invited_position 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_invited_position --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_distinctions 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_distinctions --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_distinction 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_distinction --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_memberships 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_memberships --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_membership 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_membership --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_services 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_services --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_service 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_service --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_fundings 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_fundings --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_funding 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_funding --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_peer_reviews 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_peer_reviews --json

Parameter	Type	Required	Description
No parameters.

orcid.orcid_peer_review 0 parameters

Schema command

kosmo integrations:schema orcid.orcid_peer_review --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.