Developer docs: all pages

Developers · MCP server

events_list

Upcoming calendar events, soonest first.

List upcoming events. Upcoming calendar events, soonest first.

Who can use it: Everyone in the community. Residents see the events their membership can see; owners and managers see all, staff-only events included.

Scope Effect Hints
community:read read reads only, idempotent

Description shown to assistants

Use this when the user asks for upcoming calendar events.

Arguments

Argument Type Required About
property_id string No The community’s public id (prop_web…). Pass it on every call.
limit integer No How many to return. From 1 to 50.

What it returns

Every result has content (one short sentence for the person) and structuredContent (the data below). A tool that could not run answers with isError: true and a sentence saying why; see Errors and limits.

  • property: the community.
  • events: each with id, title, description, location, starts_at, ends_at, all_day, event_type, visibility, reminder_offsets_minutes and created_via.

structuredContent follows this JSON Schema, also in tools/list as outputSchema:

{
  "type": "object",
  "properties": {
    "property": {
      "type": "object",
      "properties": {
        "id": { "type": "string" },
        "name": { "type": "string" },
        "addressLine1": { "type": ["string", "null"] },
        "addressLine2": { "type": ["string", "null"] },
        "city": { "type": ["string", "null"] },
        "state": { "type": ["string", "null"] },
        "postalCode": { "type": ["string", "null"] },
        "timezone": { "type": ["string", "null"] },
        "billingFrequency": { "type": ["string", "null"] },
        "demoClone": { "type": "boolean" },
        "demoPersona": { "type": ["string", "null"] },
        "demoExpiresAt": { "type": ["string", "null"] }
      },
      "required": ["id", "name"]
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": { "type": "string" },
          "title": { "type": "string" },
          "description": { "type": ["string", "null"] },
          "location": { "type": ["string", "null"] },
          "starts_at": { "type": ["string", "null"] },
          "ends_at": { "type": ["string", "null"] },
          "all_day": { "type": ["boolean", "null"] },
          "event_type": { "type": ["string", "null"] },
          "visibility": { "type": ["string", "null"] },
          "reminder_offsets_minutes": { "type": ["array", "null"], "items": { "type": "integer" } },
          "created_via": { "type": ["string", "null"] }
        },
        "required": ["id", "title"]
      }
    }
  },
  "required": ["property", "events"]
}

Notes

  • Only events that have not started yet are listed.
  • limit defaults to 20, at most 50.

Example

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "events_list",
    "arguments": {
      "property_id": "prop_web4k2m9q7x1v8c3n5b6z0a2s4d",
      "limit": 10
    }
  }
}

This page as Markdown: /developers/mcp/tools/events_list.md

Loading PorchQ…