Developers · MCP server
ballots_list
Ballots, newest first.
List ballots. Ballots, newest first.
Who can use it: Everyone in the community. Residents see the ballots they are eligible for; owners and managers see all.
| Scope | Effect | Hints |
|---|---|---|
community:read |
read | reads only, idempotent |
Description shown to assistants
Use this when the user asks about open, recent, or upcoming HOA ballots.
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 100. |
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.
ballots: each withid,title,description,ballot_type,status,starts_at,ends_at,eligible_rolesandoptions(idandtitle).
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"]
},
"ballots": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string" },
"title": { "type": "string" },
"description": { "type": ["string", "null"] },
"ballot_type": { "type": ["string", "null"] },
"status": { "type": ["string", "null"] },
"starts_at": { "type": ["string", "null"] },
"ends_at": { "type": ["string", "null"] },
"eligible_roles": { "type": ["array", "null"], "items": { "type": "string" } },
"options": {
"type": "array",
"items": {
"type": "object",
"properties": { "id": { "type": "string" }, "title": { "type": "string" } },
"required": ["id", "title"]
}
}
},
"required": ["id", "title", "options"]
}
}
},
"required": ["property", "ballots"]
}
Notes
- Votes are not shown, and voting is not available through MCP yet.
limitdefaults to 20, at most 100.
Example
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "ballots_list",
"arguments": {
"property_id": "prop_web4k2m9q7x1v8c3n5b6z0a2s4d"
}
}
}
This page as Markdown: /developers/mcp/tools/ballots_list.md