Tools Reference

list_properties

List all properties the authenticated user has access to in OBI.

list_properties

List all properties the user has access to in OBI. Returns property IDs, nicknames, addresses, and types.

Use Cases

  • Get an overview of all properties you can manage
  • Retrieve property IDs needed for other tools like search_items or ask_obi
  • Check which properties have been shared with you

Parameters

This tool takes no parameters.

{
  "arguments": {}
}

Example Request

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

Example Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "[{\"id\":\"550e8400-e29b-41d4-a716-446655440000\",\"nickname\":\"Main House\",\"address\":\"123 Oak Street, Austin, TX 78701\",\"type\":\"Single Family\"},{\"id\":\"6ba7b810-9dad-11d1-80b4-00c04fd430c8\",\"nickname\":\"Lake Cabin\",\"address\":\"456 Lakeview Dr, Marble Falls, TX 78654\",\"type\":\"Vacation Home\"}]"
      }
    ]
  }
}

Parsed Response

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "nickname": "Main House",
    "address": "123 Oak Street, Austin, TX 78701",
    "type": "Single Family"
  },
  {
    "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "nickname": "Lake Cabin",
    "address": "456 Lakeview Dr, Marble Falls, TX 78654",
    "type": "Vacation Home"
  }
]

Response Fields

FieldTypeDescription
idstringUUID of the property. Use this in other tools.
nicknamestringUser-defined name for the property
addressstring | nullFull address of the property
typestring | nullProperty type (e.g., "Single Family", "Condo", "Apartment")

Error Handling

Authentication Error

If not authenticated:

{
  "content": [
    {
      "type": "text",
      "text": "{\"error\": \"Unauthorized\"}"
    }
  ],
  "isError": true
}

Database Error

If unable to fetch properties:

{
  "content": [
    {
      "type": "text",
      "text": "{\"error\": \"Failed to fetch properties\"}"
    }
  ],
  "isError": true
}

Access Control

This tool returns:

  • Properties you own
  • Properties shared with you (where you have active access)

Inactive or revoked shares are not included.

  • search_items - Search inventory within a property
  • ask_obi - Ask questions about a property
  • add_item - Add items to a property's inventory