Can I use Freshchat as a CLI?

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

Can I expose Freshchat through MCP?

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

Where are Freshchat credentials stored?

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

Can I deny write access for Freshchat MCP tools?

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

support

Freshchat CLI for AI Agents

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

7 functions 6 read 1 write Bearer token auth

Submit Freshchat feedback View package source

Freshchat CLI Setup

Freshchat can be configured headlessly with `kosmokrator integrations:configure freshchat`.

# 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 freshchat --set access_token="$FRESHCHAT_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmokrator integrations:doctor freshchat --json
kosmokrator integrations:status --json

Credentials

Authentication type: Bearer token bearer_token. Configure credentials once, then use the same stored profile from scripts, coding CLIs, Lua code mode, and the MCP gateway.

Key	Env var	Type	Required	Label
`access_token`	`FRESHCHAT_ACCESS_TOKEN`	Secret `secret`	yes	Access Token
`url`	`FRESHCHAT_URL`	URL `url`	no	API Base URL

Call Freshchat Headlessly

Use the generic call form when another coding CLI or script needs a stable universal interface.

kosmo integrations:call freshchat.freshchat_list_conversations '{
  "page": 1,
  "per_page": 1,
  "status": "example_status",
  "inbox_id": "example_inbox_id"
}' --json

Use the provider shortcut form for shorter human-facing commands.

kosmo integrations:freshchat freshchat_list_conversations '{
  "page": 1,
  "per_page": 1,
  "status": "example_status",
  "inbox_id": "example_inbox_id"
}' --json

Agent Discovery Commands

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

kosmo integrations:docs freshchat --json
kosmo integrations:docs freshchat.freshchat_list_conversations --json
kosmo integrations:schema freshchat.freshchat_list_conversations --json
kosmo integrations:search "Freshchat" --json
kosmo integrations:list --json

All CLI Functions

Every function below can be called headlessly. The generic form is stable across all integrations; the provider shortcut is shorter but specific to Freshchat.

`freshchat.freshchat_list_conversations`

Read read

List support conversations from Freshchat. Returns paginated results with optional filters for status and inbox. Use this to find recent or unresolved conversations.

Parameters: page, per_page, status, inbox_id

Generic CLI call

kosmo integrations:call freshchat.freshchat_list_conversations '{"page":1,"per_page":1,"status":"example_status","inbox_id":"example_inbox_id"}' --json

Provider shortcut

kosmo integrations:freshchat freshchat_list_conversations '{"page":1,"per_page":1,"status":"example_status","inbox_id":"example_inbox_id"}' --json

`freshchat.freshchat_get_conversation`

Read read

Get full details of a specific Freshchat conversation by ID, including messages, participants, and metadata.

Parameters: id

Generic CLI call

kosmo integrations:call freshchat.freshchat_get_conversation '{"id":"example_id"}' --json

Provider shortcut

kosmo integrations:freshchat freshchat_get_conversation '{"id":"example_id"}' --json

`freshchat.freshchat_create_conversation`

Write write

Create a new Freshchat conversation. Specify the user ID, an initial message, and optionally a channel ID. The conversation will be started with the provided message.

Parameters: user_id, initial_message, channel_id

Generic CLI call

kosmo integrations:call freshchat.freshchat_create_conversation '{"user_id":"example_user_id","initial_message":"example_initial_message","channel_id":"example_channel_id"}' --json

Provider shortcut

kosmo integrations:freshchat freshchat_create_conversation '{"user_id":"example_user_id","initial_message":"example_initial_message","channel_id":"example_channel_id"}' --json

`freshchat.freshchat_list_agents`

Read read

List support agents in Freshchat. Returns paginated results with agent details such as name, email, and availability status.

Parameters: page, per_page

Generic CLI call

kosmo integrations:call freshchat.freshchat_list_agents '{"page":1,"per_page":1}' --json

Provider shortcut

kosmo integrations:freshchat freshchat_list_agents '{"page":1,"per_page":1}' --json

`freshchat.freshchat_get_agent`

Read read

Get details of a specific Freshchat agent by ID, including name, email, availability, and assigned conversations.

Parameters: id

Generic CLI call

kosmo integrations:call freshchat.freshchat_get_agent '{"id":"example_id"}' --json

Provider shortcut

kosmo integrations:freshchat freshchat_get_agent '{"id":"example_id"}' --json

`freshchat.freshchat_list_groups`

Read read

List support groups (teams) in Freshchat. Groups organize agents into teams for routing conversations.

Parameters: page, per_page

Generic CLI call

kosmo integrations:call freshchat.freshchat_list_groups '{"page":1,"per_page":1}' --json

Provider shortcut

kosmo integrations:freshchat freshchat_list_groups '{"page":1,"per_page":1}' --json

`freshchat.freshchat_get_current_user`

Read read

Get the profile of the currently authenticated Freshchat user. Useful for verifying credentials and identifying the connected account.

Parameters: none

Generic CLI call

kosmo integrations:call freshchat.freshchat_get_current_user '{}' --json

Provider shortcut

kosmo integrations:freshchat freshchat_get_current_user '{}' --json

Function Schemas

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

`freshchat.freshchat_list_conversations`

List support conversations from Freshchat. Returns paginated results with optional filters for status and inbox. Use this to find recent or unresolved conversations.

Operation: Read read
Schema command: kosmo integrations:schema freshchat.freshchat_list_conversations --json

Parameter	Type	Required	Description
`page`	integer	no	Page number for pagination (default: 1).
`per_page`	integer	no	Number of conversations per page (default: 50, max: 100).
`status`	string	no	Filter by conversation status. Possible values: "new", "open", "pending", "resolved", "closed".
`inbox_id`	string	no	Filter conversations belonging to a specific inbox by its ID.

`freshchat.freshchat_get_conversation`

Get full details of a specific Freshchat conversation by ID, including messages, participants, and metadata.

Operation: Read read
Schema command: kosmo integrations:schema freshchat.freshchat_get_conversation --json

Parameter	Type	Required	Description
`id`	string	yes	The conversation ID.

`freshchat.freshchat_create_conversation`

Create a new Freshchat conversation. Specify the user ID, an initial message, and optionally a channel ID. The conversation will be started with the provided message.

Operation: Write write
Schema command: kosmo integrations:schema freshchat.freshchat_create_conversation --json

Parameter	Type	Required	Description
`user_id`	string	yes	The ID of the user to associate with the conversation.
`initial_message`	string	yes	The first message to send in the conversation.
`channel_id`	string	no	Optional channel ID to associate the conversation with a specific channel.

`freshchat.freshchat_list_agents`

List support agents in Freshchat. Returns paginated results with agent details such as name, email, and availability status.

Operation: Read read
Schema command: kosmo integrations:schema freshchat.freshchat_list_agents --json

Parameter	Type	Required	Description
`page`	integer	no	Page number for pagination (default: 1).
`per_page`	integer	no	Number of agents per page (default: 50, max: 100).

`freshchat.freshchat_get_agent`

Get details of a specific Freshchat agent by ID, including name, email, availability, and assigned conversations.

Operation: Read read
Schema command: kosmo integrations:schema freshchat.freshchat_get_agent --json

Parameter	Type	Required	Description
`id`	string	yes	The agent ID.

`freshchat.freshchat_list_groups`

List support groups (teams) in Freshchat. Groups organize agents into teams for routing conversations.

Operation: Read read
Schema command: kosmo integrations:schema freshchat.freshchat_list_groups --json

Parameter	Type	Required	Description
`page`	integer	no	Page number for pagination (default: 1).
`per_page`	integer	no	Number of groups per page (default: 50, max: 100).

`freshchat.freshchat_get_current_user`

Get the profile of the currently authenticated Freshchat user. Useful for verifying credentials and identifying the connected account.

Operation: Read read
Schema command: kosmo integrations:schema freshchat.freshchat_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.