Skip to main content

​
Overview

Clients are used to group and organize projects in the CodeFire sidebar. Each client can have a custom name and color.

​
list_clients

List all clients with their IDs, names, and colors.

​
Parameters

No parameters required.

​
Returns

​
clients
array
Array of client objects
​
id
string
Client unique identifier (UUID)
​
name
string
Client name
​
color
string
Hex color code (e.g. “#3B82F6”)
​
sort_order
integer
Sort order for display
​
created_at
datetime
Creation timestamp

​
Example

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_clients",
    "arguments": {}
  }
}
Response: 
Clients (3):
  [abc-123-def] Acme Corporation (color: #3B82F6)
  [ghi-456-jkl] Startup Inc (color: #10B981)
  [mno-789-pqr] Personal Projects (color: #F59E0B)

​
create_client

Create a new client for grouping projects.

​
Parameters

​
name
string
required
Client name
​
color
string
Hex color code (e.g. “#3B82F6”). Optional, defaults to blue.

​
Returns

Confirmation message with the created client name and ID.

​
Example

{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "tools/call",
  "params": {
    "name": "create_client",
    "arguments": {
      "name": "Enterprise Client",
      "color": "#8B5CF6"
    }
  }
}
Response: 
Created client 'Enterprise Client' with ID stu-012-vwx

​
Notes

  • Clients are created with an auto-generated UUID as their ID
  • The sort_order is automatically assigned based on the number of existing clients
  • Client colors should be valid hex color codes (e.g. “#FF5733”)
  • Clients can be managed through the CodeFire GUI for more advanced operations like reordering and deletion
Once you have clients set up, you can associate projects with clients through the CodeFire GUI. Use the Projects API to list and work with projects.

Build docs developers (and LLMs) love

Get started for freeTalk to us