Equipment

get_equipment

Get list of equipment for the authenticated user's organization

get_equipment

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_equipment",
    "arguments": {
        "page": 1,
        "limit": 10,
        "search": "string",
        "relations": [
          "string"
        ],
        "type": "LAPTOP",
        "status": "AVAILABLE",
        "assignedToEmployeeId": "550e8400-e29b-41d4-a716-446655440000",
        "manufacturer": "string",
        "available": true
      }
  }
}

const result = await client.callTool({
  "name": "get_equipment",
  "arguments": {
    "page": 1,
    "limit": 10,
    "search": "string",
    "relations": [
      "string"
    ],
    "type": "LAPTOP",
    "status": "AVAILABLE",
    "assignedToEmployeeId": "550e8400-e29b-41d4-a716-446655440000",
    "manufacturer": "string",
    "available": true
  }
});

result = await session.call_tool("get_equipment", arguments={
  "page": 1,
  "limit": 10,
  "search": "string",
  "relations": [
    "string"
  ],
  "type": "LAPTOP",
  "status": "AVAILABLE",
  "assignedToEmployeeId": "550e8400-e29b-41d4-a716-446655440000",
  "manufacturer": "string",
  "available": true
})

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

searchstring

Search term for equipment name, model, or serial number

relationsArray<string>

Relations to include (e.g., ["assignedTo", "image", "tags", "equipmentSharings"])

typestringLAPTOPDESKTOPMONITORMOBILEPRINTERFURNITURESOFTWARE_LICENSEOTHER

Filter by equipment type

statusstringAVAILABLEASSIGNEDIN_REPAIRRETIREDLOSTDAMAGED

Filter by equipment status

assignedToEmployeeIdstring<uuid>

Filter by assigned employee ID

manufacturerstring

Filter by manufacturer

availableboolean

Filter by availability (status = AVAILABLE)

get_equipment_count

Get equipment count in the authenticated user's organization

get_equipment_count

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_equipment_count",
    "arguments": {
        "type": "LAPTOP",
        "status": "AVAILABLE",
        "assignedToEmployeeId": "550e8400-e29b-41d4-a716-446655440000",
        "manufacturer": "string"
      }
  }
}

const result = await client.callTool({
  "name": "get_equipment_count",
  "arguments": {
    "type": "LAPTOP",
    "status": "AVAILABLE",
    "assignedToEmployeeId": "550e8400-e29b-41d4-a716-446655440000",
    "manufacturer": "string"
  }
});

result = await session.call_tool("get_equipment_count", arguments={
  "type": "LAPTOP",
  "status": "AVAILABLE",
  "assignedToEmployeeId": "550e8400-e29b-41d4-a716-446655440000",
  "manufacturer": "string"
})

Parameters

typestringLAPTOPDESKTOPMONITORMOBILEPRINTERFURNITURESOFTWARE_LICENSEOTHER

Filter by equipment type

statusstringAVAILABLEASSIGNEDIN_REPAIRRETIREDLOSTDAMAGED

Filter by equipment status

assignedToEmployeeIdstring<uuid>

Filter by assigned employee ID

manufacturerstring

Filter by manufacturer

get_equipment_by_id

Get a specific equipment by ID

get_equipment_by_id

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_equipment_by_id",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_equipment_by_id",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_equipment_by_id", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "relations": [
    "string"
  ]
})

Parameters

idstring<uuid>required

The equipment ID

relationsArray<string>

Relations to include (e.g., ["assignedTo", "image", "tags", "equipmentSharings"])

create_equipment

Create a new equipment in the authenticated user's organization

create_equipment

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_equipment",
    "arguments": {
        "equipment_data": {
          "name": "string"
        }
      }
  }
}

const result = await client.callTool({
  "name": "create_equipment",
  "arguments": {
    "equipment_data": {
      "name": "string"
    }
  }
});

result = await session.call_tool("create_equipment", arguments={
  "equipment_data": {
    "name": "string"
  }
})

Request Body

{
  "equipment_data": {
    "name": "string"
  }
}

Body

application/json

equipment_dataobjectrequired

The data for creating the equipment

Show child attributes

namestringrequired

The name (required)

[key: string]any

update_equipment

Update an existing equipment

update_equipment

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_equipment",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "equipment_data": {}
      }
  }
}

const result = await client.callTool({
  "name": "update_equipment",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "equipment_data": {}
  }
});

result = await session.call_tool("update_equipment", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "equipment_data": {}
})

Parameters

idstring<uuid>required

The equipment ID

equipment_dataobjectrequired

The data for updating the equipment

update_equipment_status

Update the status of equipment

update_equipment_status

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_equipment_status",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "status": "AVAILABLE"
      }
  }
}

const result = await client.callTool({
  "name": "update_equipment_status",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "AVAILABLE"
  }
});

result = await session.call_tool("update_equipment_status", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "AVAILABLE"
})

Parameters

idstring<uuid>required

The equipment ID

statusstringAVAILABLEASSIGNEDIN_REPAIRRETIREDLOSTDAMAGEDrequired

The new status for the equipment

assign_equipment

Assign equipment to an employee

assign_equipment

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "assign_equipment",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "employeeId": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "assign_equipment",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "employeeId": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("assign_equipment", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "employeeId": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

idstring<uuid>required

The equipment ID

employeeIdstring<uuid>required

The employee ID to assign to

unassign_equipment

Unassign equipment from an employee (make it available)

unassign_equipment

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "unassign_equipment",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "unassign_equipment",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("unassign_equipment", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

idstring<uuid>required

The equipment ID

delete_equipment

Delete equipment

delete_equipment

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "delete_equipment",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "delete_equipment",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("delete_equipment", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

idstring<uuid>required

The equipment ID

get_equipment_by_employee

Get equipment assigned to a specific employee

get_equipment_by_employee

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_equipment_by_employee",
    "arguments": {
        "employeeId": "550e8400-e29b-41d4-a716-446655440000",
        "page": 1,
        "limit": 10,
        "type": "LAPTOP",
        "status": "AVAILABLE",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_equipment_by_employee",
  "arguments": {
    "employeeId": "550e8400-e29b-41d4-a716-446655440000",
    "page": 1,
    "limit": 10,
    "type": "LAPTOP",
    "status": "AVAILABLE",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_equipment_by_employee", arguments={
  "employeeId": "550e8400-e29b-41d4-a716-446655440000",
  "page": 1,
  "limit": 10,
  "type": "LAPTOP",
  "status": "AVAILABLE",
  "relations": [
    "string"
  ]
})

Parameters

employeeIdstring<uuid>required

The employee ID

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

typestringLAPTOPDESKTOPMONITORMOBILEPRINTERFURNITURESOFTWARE_LICENSEOTHER

Filter by equipment type

statusstringAVAILABLEASSIGNEDIN_REPAIRRETIREDLOSTDAMAGED

Filter by equipment status

relationsArray<string>

Relations to include

get_my_equipment

Get equipment assigned to the current authenticated user

get_my_equipment

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_my_equipment",
    "arguments": {
        "page": 1,
        "limit": 10,
        "type": "LAPTOP",
        "status": "AVAILABLE",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_my_equipment",
  "arguments": {
    "page": 1,
    "limit": 10,
    "type": "LAPTOP",
    "status": "AVAILABLE",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_my_equipment", arguments={
  "page": 1,
  "limit": 10,
  "type": "LAPTOP",
  "status": "AVAILABLE",
  "relations": [
    "string"
  ]
})

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

typestringLAPTOPDESKTOPMONITORMOBILEPRINTERFURNITURESOFTWARE_LICENSEOTHER

Filter by equipment type

statusstringAVAILABLEASSIGNEDIN_REPAIRRETIREDLOSTDAMAGED

Filter by equipment status

relationsArray<string>

Relations to include

get_available_equipment

Get available (unassigned) equipment for the authenticated user's organization

get_available_equipment

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_available_equipment",
    "arguments": {
        "page": 1,
        "limit": 10,
        "type": "LAPTOP",
        "manufacturer": "string",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_available_equipment",
  "arguments": {
    "page": 1,
    "limit": 10,
    "type": "LAPTOP",
    "manufacturer": "string",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_available_equipment", arguments={
  "page": 1,
  "limit": 10,
  "type": "LAPTOP",
  "manufacturer": "string",
  "relations": [
    "string"
  ]
})

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

typestringLAPTOPDESKTOPMONITORMOBILEPRINTERFURNITURESOFTWARE_LICENSEOTHER

Filter by equipment type

manufacturerstring

Filter by manufacturer

relationsArray<string>

Relations to include

get_equipment_statistics

Get equipment statistics for the authenticated user's organization

get_equipment_statistics

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_equipment_statistics",
    "arguments": {
        "type": "LAPTOP",
        "manufacturer": "string",
        "groupBy": "type"
      }
  }
}

const result = await client.callTool({
  "name": "get_equipment_statistics",
  "arguments": {
    "type": "LAPTOP",
    "manufacturer": "string",
    "groupBy": "type"
  }
});

result = await session.call_tool("get_equipment_statistics", arguments={
  "type": "LAPTOP",
  "manufacturer": "string",
  "groupBy": "type"
})

Parameters

typestringLAPTOPDESKTOPMONITORMOBILEPRINTERFURNITURESOFTWARE_LICENSEOTHER

Filter by equipment type

manufacturerstring

Filter by manufacturer

groupBystringtypestatusmanufacturerassignee

Group statistics by

request_equipment_sharing

Request to share equipment with another employee

request_equipment_sharing

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "request_equipment_sharing",
    "arguments": {
        "equipmentId": "550e8400-e29b-41d4-a716-446655440000",
        "shareWithEmployeeId": "550e8400-e29b-41d4-a716-446655440000",
        "shareStartDate": "string",
        "shareEndDate": "string",
        "reason": "string"
      }
  }
}

const result = await client.callTool({
  "name": "request_equipment_sharing",
  "arguments": {
    "equipmentId": "550e8400-e29b-41d4-a716-446655440000",
    "shareWithEmployeeId": "550e8400-e29b-41d4-a716-446655440000",
    "shareStartDate": "string",
    "shareEndDate": "string",
    "reason": "string"
  }
});

result = await session.call_tool("request_equipment_sharing", arguments={
  "equipmentId": "550e8400-e29b-41d4-a716-446655440000",
  "shareWithEmployeeId": "550e8400-e29b-41d4-a716-446655440000",
  "shareStartDate": "string",
  "shareEndDate": "string",
  "reason": "string"
})

get_equipment_sharing_requests

Get equipment sharing requests

get_equipment_sharing_requests

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_equipment_sharing_requests",
    "arguments": {
        "equipmentId": "550e8400-e29b-41d4-a716-446655440000",
        "employeeId": "550e8400-e29b-41d4-a716-446655440000",
        "status": "string",
        "page": 1,
        "limit": 10
      }
  }
}

const result = await client.callTool({
  "name": "get_equipment_sharing_requests",
  "arguments": {
    "equipmentId": "550e8400-e29b-41d4-a716-446655440000",
    "employeeId": "550e8400-e29b-41d4-a716-446655440000",
    "status": "string",
    "page": 1,
    "limit": 10
  }
});

result = await session.call_tool("get_equipment_sharing_requests", arguments={
  "equipmentId": "550e8400-e29b-41d4-a716-446655440000",
  "employeeId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "string",
  "page": 1,
  "limit": 10
})

search_equipment

Search equipment by name, model, serial number, or description

search_equipment

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_equipment",
    "arguments": {
        "query": "string",
        "limit": 20,
        "type": "LAPTOP",
        "status": "AVAILABLE",
        "manufacturer": "string"
      }
  }
}

const result = await client.callTool({
  "name": "search_equipment",
  "arguments": {
    "query": "string",
    "limit": 20,
    "type": "LAPTOP",
    "status": "AVAILABLE",
    "manufacturer": "string"
  }
});

result = await session.call_tool("search_equipment", arguments={
  "query": "string",
  "limit": 20,
  "type": "LAPTOP",
  "status": "AVAILABLE",
  "manufacturer": "string"
})

Parameters

querystringrequired

Search query

limitnumber20

Maximum number of results

typestringLAPTOPDESKTOPMONITORMOBILEPRINTERFURNITURESOFTWARE_LICENSEOTHER

Filter by equipment type

statusstringAVAILABLEASSIGNEDIN_REPAIRRETIREDLOSTDAMAGED

Filter by equipment status

manufacturerstring

Filter by manufacturer

Stack Overflow Website Demo