Connect an AI assistant to Vlge
Vlge publishes a Model Context Protocol (MCP) server so Claude, ChatGPT, and other MCP-capable assistants can read and, where you allow it, update your community's data as you. You sign in with your normal Vlge account, pick one community, and approve exactly which permissions the assistant gets. Nothing it does exceeds what you can already do in Vlge, and every change it makes is written to the community audit log under your name with the assistant identified as the client.
- Server URL
https://mcp.vlge.io/mcp- Authorization
- OAuth 2.1 with PKCE, issuer
https://app.vlge.io - Transport
- Streamable HTTP (stateless), JSON responses
- Client registration
- Dynamic (RFC 7591) or client-id metadata documents
Authentication
This page is only about connecting to the MCP server at https://mcp.vlge.io/mcp. There are two ways to do that. They are separate, and a key from one does not work as the other.
Sign in
Use this for a chat assistant, and for any task that assistant runs for you, including a scheduled task in Claude's or ChatGPT's cloud. The assistant keeps the sign-in you approve. You do not create a key, and you do not add an Authorization header.
When you add Vlge in Claude or ChatGPT, the assistant identifies itself to our authorization server on its own (no client id or secret for you to enter) and sends you to a Vlge consent screen. You sign in with the account you already use, pick one community, and approve permissions. There is nothing to apply for, no key to copy, and nothing to rotate. Anyone with a Vlge account can connect. What the assistant can then do is limited to that account's role in the chosen community, and to the permissions you approved.
After you approve it once, the assistant can call Vlge again later from its own servers. A Friday brief, a help desk, or a watch that runs inside Claude is still this sign-in. vlge_whoami reports you, the community, and the permissions you granted.
Setup steps are under Connect your assistant. On Claude's connector screen, choose Sign in now and leave Request headers empty.
Service key
Use this when the caller is a program you run yourself, and that program cannot open a browser for someone to sign in. A script on a laptop, a server you operate, Claude Code, or the Agent SDK connects by sending a service key as a bearer token. A scheduled task inside Claude or ChatGPT does not use this. That task uses the sign-in above.
The key starts with vlge_svc_. It works on MCP only when it is bound to exactly one community. It acts as the member who created it: every call is checked against that member's current permissions and against the scopes on the key. The same key also works on the Organization API. vlge_whoami reports persona: "service".
A personal key, which starts with vlge_live_, is refused on MCP. A key bound to several communities is refused on MCP. Creating a personal key on the API keys page does not connect an assistant.
On the connector, set authentication to No sign-in and add one request header: Authorization: Bearer vlge_svc_…. The steps, the scopes a service key can hold, and what a service key cannot do are under Scheduled agents and bots.
Webhooks and the API
Webhooks and the Organization API are different products. A header or a key on one of them does not authenticate this MCP server.
- Webhooks are calls Vlge makes to your URL. An optional custom header on an endpoint, such as
Authorization: Bearer …, is a secret Vlge sends to your receiver. It is not a Vlge key, and it is not how Claude connects. - Organization API authentication covers personal keys (
vlge_live_) and service keys (vlge_svc_) forapi.vlge.io/v1, including which scopes each kind of key can hold.
Connect your assistant
Pick your assistant to see the setup steps. Every option uses the same server URL and your normal Vlge sign-in.
Claudeclaude.ai and Claude Desktop · 6 stepsShow stepsHide steps
Claude updates its connector screens from time to time, so menu names and options may differ from what you see here. If a step doesn't match, follow Claude's current instructions for adding a custom MCP connector; the server URL and sign-in stay the same.
- 1
Open connector settings
In Claude, go to Settings → Connectors (Pro, Max, Team, or Enterprise plans). Team and Enterprise admins can add it once for the whole workspace. - 2
Add a custom connector
Choose Add custom connector. In the dialog, set the name to Vlge and the URL tohttps://mcp.vlge.io/mcp. - 3
Authentication: choose “Sign in now”
Claude offers three options and should pre-select Sign in now with a Detected tag, because Vlge asks for sign-in on the very first request. Keep that selection:
- Sign in now — recommended. You sign in to Vlge once when you add the connector, and every tool works from the first chat.
- Sign in when needed — also works. Claude connects without credentials and asks you to sign in the first time it calls a tool.
- No sign-in — only for a service key. On a signed-in connector, every tool call fails with
UNAUTHENTICATEDuntil you edit it and sign in.
- 4
OAuth client: keep “Use Claude’s published identity”
Choosing Sign in now expands the dialog with an OAuth client section. Keep the pre-selected Use Claude's published identity (marked Recommended). Vlge supports it: Claude identifies itself with a client-id metadata document that Anthropic hosts, so there is nothing to register or copy.
- Register automatically — also supported (dynamic client registration). Use it only if the recommended option fails.
- Use your own OAuth client — not needed. Vlge does not issue client ids or secrets for personal connections; leave this unselected.
Leave Request headers empty (Vlge uses the OAuth token, not an API key) and leave Advanced collapsed. Press Add.
- 5
Sign in and choose a community
A Vlge sign-in opens in your browser. Sign in with your normal account; if you belong to more than one community, pick the one this connection should act in, review the permissions, and press Allow. - 6
Enable it in a chat
In a new chat, open the tools menu and turn on Vlge. Ask Claude to callvlge_whoamifirst; it reports who you are, which community it is connected to, and what it may do.
ChatGPTDeveloper mode connector · 4 stepsShow stepsHide steps
ChatGPT updates its connector screens from time to time, so menu names and options may differ from what you see here. If a step doesn't match, follow ChatGPT's current instructions for adding a custom MCP connector; the server URL and sign-in stay the same.
- 1
Turn on developer mode
In ChatGPT, open Settings → Apps & Connectors → Advanced and enable Developer mode (available on Plus, Pro, Business, Enterprise, and Edu plans). - 2
Create the connector
Back in Apps & Connectors, choose Create, name it Vlge, set the MCP server URL tohttps://mcp.vlge.io/mcp, and set authentication to OAuth. No client id or secret is needed. - 3
Authorize
ChatGPT sends you to Vlge to sign in, choose a community, and approve permissions. You return to ChatGPT with the connector ready. - 4
Use it
In a conversation, add the Vlge connector from the + menu. Start withvlge_whoami.
Other MCP clientsAny client with Streamable HTTP and MCP authorizationShow stepsHide steps
Any client that supports Streamable HTTP with the MCP authorization specification works. Point it at https://mcp.vlge.io/mcp. On the firsttools/call without a token the server answers 401 with a WWW-Authenticate header pointing at https://mcp.vlge.io/.well-known/oauth-protected-resource, which names the issuer. From there the standard discovery chain applies:
https://app.vlge.io/.well-known/oauth-authorization-server— authorization server metadata (RFC 8414)https://app.vlge.io/api/oauth/register— dynamic client registration (RFC 7591); or present anhttpsclient id whose document we fetchhttps://app.vlge.io/oauth/authorize— authorization with PKCE (S256 only) and aresourceofhttps://mcp.vlge.io/mcphttps://app.vlge.io/api/oauth/token—authorization_codeand rotatingrefresh_tokengrants (form-encoded)https://app.vlge.io/api/oauth/revoke— token revocation (RFC 7009)
initialize, tools/list, prompts/list, and resources/list work without a token so clients and directories can inspect the server.
Scheduled agents and bots
These steps are for a service key: a program you run that sends Authorization: Bearer vlge_svc_…. A scheduled task inside Claude or ChatGPT uses sign-in and does not follow these steps.
- 1
Create a service key for one community
In Vlge, open Developer → Keys and choose Create service key. Name it for the bot (the name appears in the audit log), select one community, and pick the scopes the bot needs from the table below. You need Configure integrations in that community. Copy thevlge_svc_…secret when it is shown; Vlge does not show it again. - 2
Add Vlge as a connector with a request header
Use the server URL
https://mcp.vlge.io/mcp, set authentication to No sign-in (or None), and add one request header:Authorization: Bearer vlge_svc_…
For a client configured with JSON (Claude Code, the Agent SDK, most MCP libraries):
{ "mcpServers": { "vlge": { "type": "http", "url": "https://mcp.vlge.io/mcp", "headers": { "Authorization": "Bearer vlge_svc_…" } } } }Keep the key in your platform's secret store rather than in the prompt or a checked-in file.
- 3
Check the connection
Have the agent callvlge_whoami. It reportspersona: "service", the key name, the member it acts for, the community, and the tool families the key can use.
| MCP tools | Service key scope |
|---|---|
| ARC requests, statuses, project types (read, with comment threads) | arc.read |
| Comment on an ARC request (never emailed) | arc.write |
| Violation notices, types, statuses (read) | violations.read |
| Tickets (read) | tickets.read |
| Open, update, and comment on tickets (never emailed) | tickets.write |
| Elections (read) | elections.read |
| Access requests (read) | access_requests.read |
| Approve an access request and resend the sign-up link | access_requests.write |
| Board group posts and mailbox (read) | board_group.read |
| Post and reply in the board group; reply to board email | board_group.write |
| Community groups and members (read) | groups.read |
| Create, edit, and archive groups; add and remove members | groups.write |
| Meetings and agendas (read) | meetings.read |
| Create and edit meetings and agenda items | meetings.write |
| Tasks (read) / create and update tasks | tasks.read / tasks.write |
| Document folders and search | documents.read |
| Properties / people | properties.read / users.read |
| Balances / charges | balances.read / charges.read |
| General ledger, journal entries, books-closed date | gl.read |
| Bills, vendor payments, disbursements / vendors | bills.read / vendors.read |
| Bank accounts, transactions, reconciliations | banking.read |
- Never available to a service key: the resident
vlge_my_*tools, the rest of community content (FAQs, help, polls, forms, binder, transition planner, email drafts), vendor edits, violation imports, and anything that sends to residents. Community groups usegroups.readandgroups.write. The Board group is separate and usesboard_group.readandboard_group.write. - Meetings, documents, and elections show what the key's audience allows (member, board, or admin; only admin includes live election turnout and the voter roll), exactly as on the Organization API, even if the member who created it can see more.
- Calls count against the key's own rate limits, shared with its Organization API traffic, and appear in the key's request log as
mcp:<tool name>. Writes appear in the audit log under the key's name, attributed to the member who created it (for example MCP · service:arc-screening-bot). - If the member who created the key loses access to the community, the key stops working on MCP. Revoking the key ends access within 15 seconds.
- Write tools also need Organization API writes turned on for the community, the same as on the Organization API. Without it, reads still work and writes return
WRITES_DISABLED. - Personal keys (
vlge_live_…) and keys bound to several communities are refused on MCP.
Permissions (scopes)
You choose these on the consent screen. A scope never grants more than your Vlge role allows: every tool call also checks your capabilities in the chosen community.
| Scope | Label | What it covers |
|---|---|---|
profile | Who you are | Your name, email, and the organizations you belong to. |
self.read | My account | Your own properties: balance and charge history, your ARC requests, and violation notices at your home. Only what you can already see in My Property. |
meetings.read | Read meetings | Meeting calendar, agendas, minutes status, and supporting documents. |
meetings.write | Manage meetingswrite | Create, update, and delete meetings and agenda items. Deletes are recoverable for 45 days. |
tasks.read | Read tasks | Board and committee tasks. |
tasks.write | Manage taskswrite | Create, update, complete, and delete tasks. |
community.read | Read community content | FAQs, help sections, polls, forms, binder items, transition plans, and email drafts. |
community.write | Manage community contentwrite | Create and edit FAQs, help sections, polls, forms, binder items, transition plans, and email drafts (drafts only; sending stays in Vlge). |
groups.read | Read groups | Community groups (committees and interest groups) and their members. The Board group is a separate permission. |
groups.write | Manage groupswrite | Create and edit community groups, archive them, and add or remove members. Does not email or text anyone. The Board group is a separate permission. |
directory.read | Read the directory | Members, units, owners, and the board and committee roster. |
financials.read | Read financials | Balances, charges, payments, and delinquency summaries. Read only. |
accounting.read | Read accounting | Chart of accounts, general ledger balances, journal entries, the books-closed date, vendors, bills, vendor payments, and disbursements. Read only. |
accounting.write | Manage vendorswrite | Create and edit vendor records (name, contact, address, type, default GL account). Cannot touch bills, payments, journal entries, or bank details. |
banking.read | Read banking | Bank accounts (balances and last four digits only), bank transactions, and reconciliation sessions. Read only — nothing moves money. |
compliance.read | Read compliance | Architectural review (ARC) requests, statuses, and project types; violation notices, violation types, and statuses. |
arc.write | Comment on ARC requestswrite | Add comments to architectural review requests. Committee-only by default. Does not email anyone or change a decision. |
compliance.write | Import violation historywrite | Record historical violation notices brought over from a previous system. Imports never notify residents or post fines; issuing new notices stays in Vlge. |
tickets.read | Read tickets | Support tickets with their comment threads, statuses, and contact reasons. |
tickets.write | Manage ticketswrite | Open tickets, change status or assignee, and comment. Does not email anyone. |
access_requests.read | Read access requests | People asking to join the community: name, contact, the address they gave, and which homes and owners it matches. |
access_requests.write | Approve access requestswrite | Approve a pending request and resend the sign-up link. Vlge emails the requester their sign-up link, as when an admin approves. Cannot deny or change anyone’s sign-in email. |
board_group.read | Read the board group | Posts and replies in the Board group, and the board mailbox (emails received and sent from the board address). |
board_group.write | Post to the board groupwrite | Create a post, reply to a post, and reply from the board address to an email the board received. Each one shows the key or connection name. No edit or delete; posts do not email members. |
elections.read | Read elections | Elections, ballots, turnout, released results, the voter roll, and paper-ballot entries. How anyone voted is never included. |
documents.read | Read documents | Document folders and files you can already see in Vlge. |
communications.send | Send noticeswrite | Send meeting notices and other resident communications. Every send asks you to confirm first. |
offline_access | Stay connected | Keep the connection alive without signing in again (refresh tokens). |
What an assistant can do
Tools mirror the Vlge screens an admin or board member already uses. Each row lists the domain, what the assistant can change, and the guardrails that are specific to it. Reads are always safe to call.
| Area | Writes | Guardrails |
|---|---|---|
| Meetings | Create, update, delete meetings; add, edit, delete agenda items; preview and send meeting notices. | Deletes go to Rewind. Agenda edits are refused once the agenda is locked (AGENDA_LOCKED); a topic with subtopics cannot be demoted (HAS_SUBTOPICS). Notices require the confirmation handshake. |
| Tasks | Create and update tasks, assignees, due dates, and status. | Statuses, priorities, and assignees must come from vlge_list_task_options for that community. |
| FAQs and Help | Create and update FAQs; create, update, delete help sections. | Help-section deletes go to Rewind. Per-community section limit applies (HELP_SECTION_LIMIT_REACHED). |
| Groups | Create, update, archive groups; list, add, and remove members. | Same approval rules as the UI: a group created by someone without group-admin rights lands in pending approval. System groups keep their membership type. SMS fan-out follows the community's feature flag (FEATURE_DISABLED). Members must already be in the community. |
| Polls | Create, update, delete polls and their questions. | Always created as draft; the assistant cannot open voting. Questions cannot be replaced once a poll has responses (POLL_HAS_RESPONSES). Deletes go to Rewind. |
| Forms | Create, update, delete forms and fields. | Created inactive by default. A form with submissions is deactivated rather than deleted so responses stay available. |
| Board binder | Create, update, archive binder items in any category. | Edits respect item ownership. Values that look like passwords, keys, or account numbers are refused with SECRET_WARNING until the user explicitly confirms (acknowledge_secrets). |
| Transition planner | Create and update plans, sections, and items (owners, dates, dependencies). | Owners must be community members; dependency cycles are rejected (CIRCULAR_DEPENDENCY). |
| Community email | Draft an email to everyone, selected groups, or selected people. | Draft only. Nothing is sent until you open Messaging Center and send it yourself. |
| Vendors | Create and update vendor records (name, contact, address, type, default GL account, accepted payment methods, archive / reactivate). | Same rules as the vendor form: names are unique per community (DUPLICATE_VENDOR returns the existing id), and bank account, ACH, and tax-id fields are not accepted at all — vendors supply those through the vendor portal. |
| Violation history | Import notices that were already issued in a previous system (vlge_import_violation). | Import, not issue. The date must be today or earlier (NOT_HISTORICAL), nothing is emailed or mailed, no fine is posted, and the record is tagged imported in its timeline. external_reference makes re-runs return the existing record. New notices are issued in Vlge so delivery, consent, and fine rules apply. |
| Directory and financials | Read only: properties, owners, people, balances, charges, documents. | Gated by the same capabilities as the matching Vlge pages. No payment, charge, or ledger writes exist. |
| Accounting | Read only: chart of accounts, GL balances for a period, books-closed date, journal entries with lines, vendors with payment history, bills with approvals and payments, vendor payments, manual disbursements. | Same permission as the Financials pages. Balances count posted entries only. Vendor bank and tax details never leave the server. |
| Banking | Read only: bank accounts and balances, bank transactions, reconciliation sessions and their matches. | Last four digits only. Nothing here can move money, link an account, or change a reconciliation — the banking.read scope has no write counterpart. |
| Compliance | Read ARC requests with votes, history, and the full comment thread; ARC statuses and project types; violation notices with comments, file metadata, and timeline; violation types, statuses, and action types. Comment on an ARC request (vlge_comment_on_arc_request). | ARC committee comments are included and marked homeowner_visible. New comments are committee-only unless homeowner_visible is set, which needs permission to share committee comments; they are never emailed. The resident “my ARC” tools still hide committee comments. Violation staff-only comments stay excluded. Files are metadata only. ARC decisions and new violation notices are made in Vlge. |
| Tickets | Read tickets with their comment threads, statuses, and reasons. Open a ticket, change its status or assignee, and comment. | Staff-only comments are included (internal: true). Writes never email anyone. Requires the Ticket Support feature and permission to manage tickets. |
| Elections | Read elections, ballots, live turnout, released results, the voter roll, and paper-ballot entries. | Read only. How anyone voted, receipts, and voting links are never returned. Who voted is withheld until voting has ended. Requires permission to view elections. |
| My account (residents) | Read only, for homeowners and occupants without a board or admin role: your properties, amount due and overdue, charge and payment history, your ARC requests, and violation notices at your home. | Scoped to the properties you currently own or occupy and to the per-occupant ACC and notice access your community set. Staff notes and internal timelines are excluded. Paying, submitting an ARC request, and replying to a notice stay in Vlge. |
Error codes
Every failed call returns { error: { code, message, hint?, details?, retryAfterSeconds?, status } }. Codes are stable; messages and hints are written for the assistant to relay to you. The ones you are most likely to see:
| Code | Meaning | What to do |
|---|---|---|
UNAUTHENTICATED | No valid access token was sent. | Complete the sign-in your client offers, then retry. |
INSUFFICIENT_SCOPE | The connection was not granted the scope this tool needs. | Disconnect and reconnect, approving the missing permission. |
PERMISSION_DENIED | Your Vlge role in this community does not allow the action. | Ask a community admin for the capability; the assistant cannot work around it. |
VALIDATION_ERROR / MISSING_FIELD / INVALID_FIELD / INVALID_ENUM_VALUE | An argument is missing, malformed, or not one of the allowed values. | The message names the argument; for zod failures details lists each path and problem, and enum errors list the accepted values. |
NOT_FOUND | The id does not exist in the selected community. | List first; ids are community-scoped and never guessable. |
CONFIRMATION_REQUIRED | The action reaches residents and needs your approval. | Review details.confirmation.summary; call again with confirmation_token only after you say yes. |
RATE_LIMITED | Per-connection minute, day, or write limit reached. | Wait error.retryAfterSeconds and retry. |
FEATURE_DISABLED | The community has this feature switched off. | Enable it under Admin → Features, or skip the step. |
DUPLICATE_GROUP / EMAIL_ALIAS_TAKEN / SLUG_TAKEN | A unique name, alias, or slug is already used. | Pick a different value. |
ALREADY_MEMBER / USER_NOT_IN_ORGANIZATION | Group membership conflict, or the person is not in this community. | Check the people list; invite the person in Vlge first. |
POLL_HAS_RESPONSES | Questions cannot be replaced after voting started. | Create a new poll or edit only title, description, and dates. |
SECRET_WARNING | A binder value looks like a credential. | Confirm with the user, then retry with acknowledge_secrets=true. |
AGENDA_LOCKED / HAS_SUBTOPICS | The agenda is locked, or a topic with subtopics cannot be demoted. | Unlock the agenda in Vlge, or move the subtopics first. |
CIRCULAR_DEPENDENCY / DEPENDENCY_NOT_FOUND | Transition-plan dependency forms a loop or references a missing item. | Fix the dependency list. |
MCP_PAUSED | Vlge has temporarily paused the MCP server. | Try again later; the web app is unaffected. |
INVALID_SERVICE_KEY / CREDENTIAL_REVOKED / CREDENTIAL_EXPIRED | Service key only: the key is unknown, revoked, or expired (HTTP 401). | Create a new key under Developer → Keys. |
SINGLE_COMMUNITY_KEY_REQUIRED | Service key only: the key is bound to several communities or to all of them. | Create a key for exactly one community. |
ISSUER_NO_LONGER_HAS_ACCESS | Service key only: the member who created it lost access to the community. | Have a current member create a new key. |
NOT_AVAILABLE_TO_SERVICE_KEYS | Service key only: the tool needs a signed-in person. | Use OAuth sign-in for that work. |
WRITES_DISABLED | Service key only: "Organization API writes" is off for this community. | Ask a community admin or Vlge support to turn it on; reads keep working. |
SERVICE_KEYS_DISABLED | Vlge has turned off service keys on MCP. | Use OAuth sign-in, or try again later. |
Seeing what an assistant did
- Audit log. Community admins open Admin Tools → Audit Log and set Client to AI assistants. Every MCP write appears there under your name with the connector identified (for example MCP · Claude), alongside any action an assistant took through the regular API with your browser session.
- AI connections. Admin Tools → AI connections lists every assistant connected to the community, who connected it, the scopes it holds, and when it was last used. Admins can revoke a connection there.
- Your own connections. Profile → Security → Connected AI apps shows the assistants you have authorized and lets you disconnect them.
- Assistants using the REST API directly. A desktop assistant that drives Vlge with your signed-in browser session instead of this connector is still identified by its user agent and tagged in the same audit log. Those calls are limited to 60 writes per 10 seconds and 300 per minute per user and get the same
CONFIRMATION_REQUIREDhandshake on resident-facing actions. The MCP connector is the supported path.
Safety and limits
- Every write is recorded in the community audit log as you, tagged with the assistant that made it.
- Deleted meetings, polls, forms, and help sections go to Rewind and can be restored by an admin for 45 days.
- Community emails are draft-only from an assistant:
vlge_create_email_draftstages the message in Messaging Center and you send it from Vlge. - Anything that reaches residents (for example
vlge_send_meeting_notice) is a two-step handshake: the first call returnsCONFIRMATION_REQUIREDwith recipient counts and a single-use token; the assistant must show you that summary and call again withconfirmation_tokenonly after you approve. Changing any argument invalidates the token. - Each connection is limited to 60 calls per minute, 3,000 per day, and 20 writes per minute. Exceeding a limit returns
RATE_LIMITEDwith a retry time. Service keys use their own Organization API limits instead. - Access tokens last one hour; refresh tokens rotate on every use and expire after 30 days of inactivity.
- Disconnect an assistant any time from Profile → Security → Connected AI apps in Vlge. Access ends immediately.
Tools
Results are JSON. Errors come back as { error: { code, message, hint } } so the assistant can explain what went wrong and what to do next.
- profile1
- self7
- meetings9
- elections9
- communications2
- tasks4
- tickets6
- directory3
- access_requests3
- board_group7
- financials2
- accounting13
- banking4
- compliance10
- arc1
- documents2
- community32
- groups7
profile
- profile
vlge_whoamiWho am IReturns the signed-in Vlge user (or, for a service key, the key and the member who created it), the community (organization) this connection is bound to, the permissions granted to this connection, and what it can do. Call this first to orient yourself before other tools.
self
- self.read
vlge_my_propertiesMy propertiesLists the properties the signed-in user currently owns or occupies in this community, with the user’s relationship (owner / occupant) and their ACC and notice access level at each. The first row is the user’s primary property and is the default for the other vlge_my_* tools. Read-only.
- self.read
vlge_my_account_summaryMy account summaryAmount due, overdue amount, unapplied credit, and collection status for each property the user owns (occupants who are not financially responsible are excluded). Amounts are integer cents plus formatted strings. When a community hides balances during collections, amounts come back null with balance_hidden=true — tell the user to contact the office. Read-only.
- self.read
vlge_my_ledgerMy charge and payment historyThe running ledger for one of the user’s owned properties (defaults to the primary property): dated charge and payment lines with a running balance, newest first. Amounts are integer cents plus formatted strings. Use `limit` to page; the most recent lines come first. Read-only.
- self.read
vlge_my_arc_requestsMy ARC requestsArchitectural review (ARC / ACC) requests the user submitted, plus every request at properties where they are an owner or have full ACC access. Includes the user’s own unsubmitted drafts (is_draft=true). Newest first. Read-only — new requests are submitted in Vlge.
- self.read
vlge_my_arc_requestGet one of my ARC requestsOne ARC request the user can see (their own, or at a property where they have full ACC access), with status history, homeowner-visible comments, and attached file names. Read-only.
- self.read
vlge_my_violationsMy violation noticesViolation notices issued for the user’s properties (only where the user has notice access, and only notices the community has made visible to residents). Shows the resident-facing status, dates, and any cure-by deadline. Newest first. Read-only — responses are sent in Vlge.
- self.read
vlge_my_violationGet one of my violation noticesOne violation notice at the user’s property with the resident-visible conversation (public comments plus the user’s own) and attached file names. Staff-only notes and the internal audit trail are not included. Read-only.
meetings
- meetings.read
vlge_list_meetingsList meetingsLists community meetings the signed-in user can see (board-only meetings only for board/admin users). Filter by status, type, or date range. Dates are the community's local calendar dates. Ordered by meeting date. When `truncated` is true, call again with the same filters and `offset` equal to the previous offset plus `count`.
- meetings.read
vlge_get_meetingGet meetingReturns one meeting with its agenda items, attached documents the user may see, recorded decisions, and approved minutes.
- meetings.write
vlge_create_meetingCreate meetingwriteCreates a community meeting as a draft (or completed when dated in the past). Times are the community's local wall-clock HH:mm. Publishing the meeting and sending notices happen in the Vlge app so a person reviews the notice first. Confirm name, date, time, and visibility with the user before calling.
- meetings.write
vlge_update_meetingUpdate meetingwriteChanges fields on an existing meeting. Published meetings keep their name, date, start time, and RSVP setting locked (the app handles reschedules so members are notified). End time can still be corrected. Archived meetings cannot be changed.
- meetings.write
vlge_delete_meetingDelete meetingwriteMoves a meeting to Rewind (soft delete). An admin can restore it from Admin → Tools → Rewind for 45 days. Always confirm with the user, by name and date, before deleting.
- meetings.read
vlge_list_agenda_itemsList agenda itemsLists the working agenda for a meeting in display order, including subtopics (parent_id) and whether each item needs a vote. Also reports whether the agenda is locked (finalized for a published meeting) — locked agendas cannot be edited through this connector.
- meetings.write
vlge_add_agenda_itemAdd agenda itemwriteAdds one topic to a meeting agenda (appended last unless display_order is given). Call once per topic; to build a full agenda, add items in order. Fails with AGENDA_LOCKED when the agenda was finalized for a published meeting.
- meetings.write
vlge_update_agenda_itemUpdate agenda itemwriteChanges fields on one agenda item. Only the fields you pass are changed; pass null to clear description, owner, duration, or parent_id. Fails with AGENDA_LOCKED when the agenda is finalized.
- meetings.write
vlge_delete_agenda_itemDelete agenda itemwritePermanently removes one agenda item (and its subtopics). Not recoverable from Rewind — the removed content is kept in the audit log so an admin can re-create it, but confirm the item title with the user first. Fails with AGENDA_LOCKED when the agenda is finalized.
elections
- elections.read
vlge_list_electionsList electionsLists this community’s elections, oldest first, including drafts and test elections. Filter by status: draft, test, scheduled, live, ended, closed, cancelled, or archived. Individual ballots are never included. Read-only.
- elections.read
vlge_get_electionGet electionReturns one election with its ballot items and choices (no vote counts). results_available says whether vlge_get_election_results will return a tally. How anyone voted is never included. Read-only.
- elections.read
vlge_get_election_turnoutGet election turnoutReturns live participation totals for one election: eligible count, ballots cast, percent, weight, and whether quorum is met. Counts only — never who voted or what they chose. Read-only.
- elections.read
vlge_get_election_resultsGet election resultsReturns the released tally for one election: participation, per-item totals, and winners. Preliminary while paper ballots can still be counted. Write-in names are not returned, only the write-in count. 409 when results have not been released. Read-only.
- elections.read
vlge_list_election_votersList election votersLists the voter roll for one election, oldest first: name, property, and voting weight. Whether someone voted is included only after voting has ended. Emails, voting links, and what was chosen are never included. Read-only.
- elections.read
vlge_list_election_paper_ballotsList paper ballot entriesLists paper ballots counted for one election, oldest first, after voting has ended. Each entry is who it was counted for and how it was entered (manual or scanned). Selections, write-in text, and scan images are never included. 409 before voting ends. Read-only.
- elections.read
vlge_get_election_mailingsGet election mailingsLists the postal mail jobs sent for one election (voting letters and paper-ballot packages), oldest first, with piece counts, the scheduled send time, and USPS scan dates: when the first piece was scanned, how many pieces have been scanned, when every piece had been scanned, and USPS acceptance when the print vendor reports it (certified mail). Dates are ISO timestamps plus the calendar date in the community’s time zone. No addresses or letter contents. Read-only.
- elections.read
vlge_list_quick_votesList quick votesLists this community’s quick votes (board and committee votes), newest first: title, status, voting window (open, scheduled, paused, closed), open and close times, who votes (board, committee, or group), and how many have voted. Filter by status: draft, open, paused, or closed. Use vlge_get_quick_vote for questions, turnout, and tallies. Read-only.
- elections.read
vlge_get_quick_voteGet quick voteReturns one quick vote with its questions and options, who has voted, and per-question tallies (outcome, counts, winners). Tallies appear once the admin screen would show them: after the vote closes, or while it runs if you are its runner. How each person voted is included only for open-ballot votes; secret ballots never include it. turnout and tallies are null when not yet visible, and visibility says why. Emails are never returned. Read-only.
communications
- communications.send
vlge_preview_meeting_noticePreview meeting noticeShows what vlge_send_meeting_notice would do: who would receive it per channel, the community's default notice subject/body (with {{placeholders}} such as {{meetingName}} and {{rsvpUrl}} that Vlge fills per recipient), whether live email sending is on, and notices already sent for this meeting. Read-only — call this before offering to send.
- communications.send
vlge_send_meeting_noticeSend meeting noticewriteEmails and/or mails the meeting notice to the meeting audience. Two-step: the first call returns CONFIRMATION_REQUIRED with recipient counts and a single-use token; show that summary to the user and call again with identical arguments plus confirmation_token only after they explicitly approve. Sending a live notice also publishes a draft meeting. Postal mail is billed to the community and needs the postal-mail permission. Omit subject/html_body to use the community's default notice template.
tasks
- tasks.read
vlge_list_task_optionsList task statuses and categoriesReturns the task statuses and categories configured for this community, plus people who can own tasks. Use before creating or updating tasks.
- tasks.read
vlge_list_tasksList tasksLists tasks in the community task list. Users without "view all tasks" see their own tasks, tasks they collaborate on, and non-private tasks. Open tasks sort first. When `truncated` is true, call again with the same filters and `offset` equal to the previous offset plus `count`.
- tasks.write
vlge_create_taskCreate taskwriteCreates a task in the community task list. Defaults: owner = the signed-in user, status = "New", priority = medium, not private.
- tasks.write
vlge_update_taskUpdate taskwriteUpdates a task's fields or moves it to another status (use a final status such as "Done" to complete it). Owners can edit their own tasks; "edit any task" is required for others.
tickets
- tickets.read
vlge_list_ticket_optionsList ticket statuses and reasonsLists active ticket statuses (id, name, is_final) and contact reasons (id, name, description, requires_address, sla_days). Use these ids with the other ticket tools. Routing email addresses are not included. Read-only.
- tickets.read
vlge_list_ticketsList ticketsLists the community’s support tickets, oldest first. Filter by status, assignee, or reason. Deleted tickets are never returned. Comment threads are on vlge_get_ticket, not on this list. The admin scratch pad is never returned. Read-only.
- tickets.read
vlge_get_ticketGet ticketReturns one support ticket with its comment thread, oldest first. Includes staff-only comments (internal: true) and requester-visible ones. Deleted comments and the admin scratch pad are omitted. Read-only.
- tickets.write
vlge_create_ticketOpen a ticketwriteOpens a support ticket in the default status, attributed to the signed-in user. Send reason_id from vlge_list_ticket_options and details. Send requester_user_id to open it for a member, or contact_name and contact_email when there is no member. address_id is required when the reason requires an address. Does not email anyone.
- tickets.write
vlge_update_ticketUpdate a ticketwriteMoves a ticket’s status, reassigns it, or sets resolution notes. Send at least one of status_id, assignee_id, or resolution_notes. The first move into a final status sets resolved_at. assignee_id null unassigns. Does not email the requester.
- tickets.write
vlge_comment_on_ticketComment on a ticketwriteAdds a comment as the signed-in user. Internal (staff-only) by default; send internal: false to show it to the requester. Does not email the requester. Read the thread back with vlge_get_ticket.
directory
- directory.read
vlge_list_propertiesList propertiesLists properties (units / lots) in the community, including each property’s tags. Search matches street number, street name, unit, lot number, or parcel id. Use the returned `id` as property_id in other tools — never the display address. When `truncated` is true, call again with the same filters and `offset` equal to the previous offset plus `count`.
- directory.read
vlge_get_propertyGet property with ownersReturns one property with its current owners (name, email, phone, primary-contact flag) and its property tags (for example Single Family, Villa, Townhome). `property_type` is the type key; `tags` are the labels assigned on the property.
- directory.read
vlge_list_peopleList peopleLists people who hold a role in this community (owners, residents, board, staff). Search matches name or email. Returns contact details; treat them as private community data. When `truncated` is true, call again with the same filters and `offset` equal to the previous offset plus `count`.
access_requests
- access_requests.read
vlge_list_access_requestsList access requestsLists people who asked to join the community, oldest first (default: pending only). Each has the name, email, and phone they gave and the street they typed. Pending requests also list up to 3 matching homes with their current owners and whether an owner’s email or name matches the requester. Use a match’s address_id and an owner’s user_id with vlge_approve_access_request. Read-only.
- access_requests.write
vlge_approve_access_requestApprove an access requestwriteApproves a pending access request. Vlge emails the requester a one-time sign-up link (the same email an admin approval sends); the link is never returned here. Send address_id to tie them to a home, and matched_user_id to attach them to an existing person (for example the owner on record) instead of creating a new one. Requests cannot be denied here.
- access_requests.write
vlge_resend_access_approvalResend the sign-up linkwriteEmails a fresh sign-up link to someone whose access request was approved but who has not finished signing up. The previous link stops working. The link is never returned here.
board_group
- board_group.read
vlge_list_board_postsList board group postsLists posts in the Board group, newest first, with a text preview, author, reply count, and posted_via (the key or connection that wrote it, if any). Use vlge_get_board_post for the full text and replies. Read-only.
- board_group.read
vlge_get_board_postGet a board group postOne Board group post with its full text and every reply, oldest reply first. Read-only.
- board_group.read
vlge_list_board_mailboxList the board mailboxLists emails in the board mailbox, newest first: inbox (received), sent (sent from the board address), or archived. Each has the sender, recipients, subject, a text preview, and sent_via for messages sent through a key or connection. Use vlge_get_board_email for the full text. Read-only.
- board_group.read
vlge_get_board_emailGet a board mailbox emailOne email from the board mailbox with its full readable text and attachment names. Read-only.
- board_group.write
vlge_create_board_postPost to the board groupwriteCreates a post in the Board group. The app shows it with the key or connection name. Board members are not emailed about it. Confirm the wording with the user first.
- board_group.write
vlge_reply_to_board_postReply to a board group postwriteAdds a reply to a Board group post. The app shows it with the key or connection name. Archived posts cannot be replied to.
- board_group.write
vlge_reply_to_board_emailReply to a board mailbox emailwriteSends a reply from the board address to an email the board received. It goes to the original sender (reply_all adds the other To and Cc addresses), threads in their mail client, and appears in the Sent list with the key or connection name. This sends a real email: confirm the recipients and wording with the user first.
financials
- financials.read
vlge_list_balancesList property balancesLists per-property account balances (owed, pending, overdue, unapplied credit) in integer cents plus a formatted `total_balance` string. Filter to one property or to accounts with a balance. Read-only; recording payments and charges happens in the Vlge app. When `truncated` is true, call again with the same filters and `offset` equal to the previous offset plus `count`.
- financials.read
vlge_list_chargesList chargesLists unit charges (assessments, fees, fines) with amounts in integer cents and a formatted `amount` string. Filter by property, status, or due-date range. When `truncated` is true, call again with the same filters and `offset` equal to the previous offset plus `count`.
accounting
- accounting.read
vlge_list_gl_accountsList chart of accountsLists the general ledger chart of accounts (account number, name, type, parent, active flag), ordered by account number. Filter by account_type or active status. Use the returned `id` as `account_id` in vlge_list_journal_entries and `gl_account_id` elsewhere. When `truncated` is true, call again with the same filters and `offset` equal to the previous offset plus `count`. Read-only.
- accounting.read
vlge_get_gl_balancesGet GL account balancesTrial-balance style view for a date range: for every GL account, opening balance before period_start, debits/credits inside the period, and the ending balance — all integer cents, using natural-balance signs (assets/expenses positive when debit-heavy; liabilities/equity/revenue positive when credit-heavy). Only posted journal entries count. Accounts with no activity and a zero balance are omitted unless include_zero=true. Read-only.
- accounting.read
vlge_get_accounting_periodGet books-closed dateReturns the date through which the books are closed (no journal entries may be posted on or before it), when it was closed, and any note. `closed_through` is null when the books have never been closed. Read-only.
- accounting.read
vlge_list_journal_entriesList journal entriesLists general ledger journal entries with their lines (account, debit/credit cents, memo), newest entry date first. Filter by date range, status (draft/posted/voided), source_type, a GL account that appears on the entry, or vendor. Use offset to page. Read-only — posting, editing, and voiding entries happens in Vlge.
- accounting.read
vlge_get_journal_entryGet journal entryReturns one journal entry with all of its lines. Read-only.
- accounting.read
vlge_list_vendorsList vendorsLists the community’s vendors (name, contact, address, type, default GL account, accepted payment methods), alphabetical. Active vendors only unless include_inactive=true. Bank account numbers, tax ids, and ACH details are never returned. Read-only; use vlge_create_vendor / vlge_update_vendor to change vendors.
- accounting.read
vlge_get_vendorGet vendor with historyReturns one vendor plus its history: open bills, the most recent bills, the most recent payments, and lifetime totals (billed, paid, outstanding) in integer cents with formatted strings. Read-only.
- accounting.read
vlge_list_billsList billsLists vendor bills (payables) with status, due date, amount in integer cents, approval counts, and GL coding, newest due date first. Filter by vendor, status, or due-date range. Read-only — approving and paying bills happens in Vlge.
- accounting.read
vlge_get_billGet billReturns one vendor bill with its approvals and payments. Invoice file contents are not available through this connection. Read-only.
- accounting.read
vlge_list_vendor_paymentsList vendor paymentsLists payments made to vendors through Vlge (check, ACH, card) with method, status, amount in integer cents, check number, and settlement dates, newest first. Filter by vendor, bill, status, method, or initiated-date range. Read-only.
- accounting.read
vlge_list_disbursementsList manual disbursementsLists disbursements recorded by hand (checks written outside Vlge, wires, petty cash) with payee, amount in integer cents, issue date, GL coding, and status, newest issue date first. Filter by status, linked bill, or issue-date range. Read-only.
- accounting.write
vlge_create_vendorCreate vendorwriteAdds a vendor to the community’s vendor list so bills can be coded and paid to it. Only `name` is required. Names must be unique within the community; if a vendor already exists with that name you get DUPLICATE_VENDOR with its id. Bank account, ACH, and tax-id details cannot be set here — the vendor supplies those through the Vlge vendor portal. Read the name and contact details back to the user before calling.
- accounting.write
vlge_update_vendorUpdate vendorwriteEdits a vendor. Only the fields you pass change; pass null to clear a text field. Set is_active=false to archive (hides from pickers, keeps history) or true to reactivate. Renaming to a name another vendor already uses fails with DUPLICATE_VENDOR. Bank, ACH, and tax-id fields cannot be changed here.
banking
- banking.read
vlge_list_bank_accountsList bank accountsLists the community’s bank accounts across every source — linked (Plaid), manually tracked, and Western Alliance — with current and available balances in integer cents plus formatted strings, last four digits, purpose (operating/reserve), and the linked GL account. Only active accounts unless include_inactive=true. Use the returned `id` with vlge_list_bank_transactions. Read-only; account numbers are never returned.
- banking.read
vlge_list_bank_transactionsList bank transactionsLists transactions for one bank account (id from vlge_list_bank_accounts), newest first. `amount_cents` is negative when money left the account and positive when it arrived. Filter by date range or reconciled status. Read-only.
- banking.read
vlge_list_bank_reconciliationsList bank reconciliationsLists bank reconciliation sessions (statement date, statement balances, cleared debits/credits, computed ending balance, difference, status), newest statement first. Filter by status, GL cash account, or statement-date range. Read-only.
- banking.read
vlge_get_bank_reconciliationGet bank reconciliationReturns one reconciliation session with every cleared match (bank transaction ↔ journal entry). Read-only.
compliance
- compliance.read
vlge_list_arc_requestsList ARC requestsLists submitted architectural review requests (project, property, owner, status, post-approval status, submitted date, flags), newest first. Drafts and deleted requests are never returned. Filter by status, property, project type, submitted-date range, archived, or flagged. Use vlge_list_arc_statuses to translate status ids. Read-only.
- compliance.read
vlge_get_arc_requestGet ARC requestReturns one architectural review request with votes, status history, the full comment thread (homeowner-visible and committee-only; each comment has homeowner_visible), file metadata (names and ids; read a file with vlge_get_arc_file), contractors, and the owner’s questionnaire answers (custom questions and the answers they submitted). Read-only.
- compliance.read
vlge_get_arc_fileGet ARC fileReturns the contents of one file attached to an architectural review request so you can look at it: photos come back as images, PDFs (site plans, drawings, surveys) as page text plus page images, up to 5 pages per call (use page_from for the rest). File ids come from vlge_get_arc_request. Read-only.
- compliance.read
vlge_list_arc_statusesList ARC statusesLists the architectural review status catalog: review-phase statuses (pending, approved, denied, …) and post-approval statuses (in progress, complete, …), with their ids, colors, and whether they count as approved/final. Active statuses only unless include_inactive=true. Read-only.
- compliance.read
vlge_list_arc_project_typesList ARC project typesLists the project types homeowners can pick when submitting an architectural review request (fence, paint, roof, …). Active only unless include_inactive=true. Read-only.
- compliance.read
vlge_list_violationsList violation noticesLists violation notices (type, property, action, dates, board and homeowner status, delivery, whether it was imported), newest violation date first. Drafts and deleted notices are never returned. Filter by property, violation type, board status, open/resolved, date range, or imported. Use vlge_list_violation_statuses and vlge_list_violation_types to translate ids. Read-only.
- compliance.read
vlge_get_violationGet violation noticeReturns one violation notice with its non-private comments, attached file metadata (names only — no contents), and the staff audit timeline. Read-only.
- compliance.read
vlge_list_violation_typesList violation typesLists the community’s violation types (name, CC&R code and language, curability, fine in integer cents, default cure days). Active only unless include_inactive=true. Use the id as violation_type_id in vlge_list_violations and vlge_import_violation. Read-only.
- compliance.read
vlge_list_violation_statusesList violation statuses and actionsLists the three catalogs a notice is tagged with: board statuses (the staff workflow — New, Under Review, Resolved, …), homeowner statuses (what the resident sees and can respond with), and notice action types (Courtesy Note, Warning, Fine, Legal Action, …, with whether each waives the fine). Read-only.
- compliance.write
vlge_import_violationImport historical violation noticewriteRecords a violation notice that was ALREADY issued in a previous system, so a community moving to Vlge keeps its history. This is not how to issue a new notice: nothing is emailed or mailed, no fine is posted, and the record is tagged "imported" in its timeline. violation_date must be today or earlier. Identify the type by violation_type_id or violation_type_name, and the status by board_status_id or board_status_name (defaults to "New"; pass resolved_date to record a closed notice). Pass external_reference (the old system’s id) so re-running the import returns the existing record instead of a duplicate. Read the property, type, dates, and status back to the user before calling — residents can see imported notices on their property unless visible_to_resident=false.
arc
- arc.write
vlge_comment_on_arc_requestComment on an ARC requestwriteAdds a comment to an architectural review request. Committee-only by default; homeowner_visible: true shows it to the homeowner and requires permission to share committee comments. Does not email anyone and does not change the decision. Read the thread back with vlge_get_arc_request.
documents
- documents.read
vlge_list_document_foldersList document foldersLists the document folders the signed-in user can see (board-only folders only for board/admin users), with document counts.
- documents.read
vlge_search_documentsSearch documentsFinds community documents (governing documents, minutes, financials, forms) by name or description, optionally within one folder. Returns metadata only; share the document name and folder with the user, who can open it in Vlge. When `truncated` is true, call again with the same filters and `offset` equal to the previous offset plus `count`.
community
- community.read
vlge_list_faqsList community FAQsLists the published community FAQs: question, plain-text `answer` (for reading), and `answer_html` (the stored answer with tables, lists, and links). When editing a FAQ with vlge_update_faq, start from `answer_html` and send HTML back so formatting is not flattened. Useful for answering resident questions about rules, dues, amenities, and procedures from the community's own words. When `truncated` is true, call again with the same filters and `offset` equal to the previous offset plus `count`.
- community.write
vlge_create_faqCreate FAQwriteAdds a community FAQ. `answer` may be plain text (paragraphs separated by blank lines) or HTML. Published immediately unless draft=true — residents see published FAQs in the app, so read the question and answer back to the user before calling. A URL slug is generated from the title.
- community.write
vlge_update_faqUpdate FAQwriteEdits a community FAQ. Only the fields you pass change. Set archived=true to retire it (hidden from residents, recoverable in the app); set draft=false to publish a draft. Use vlge_list_faqs (published) to find ids — ask the user for the FAQ title if it is a draft or archived.
- community.read
vlge_list_help_sectionsList help sectionsLists the community's Help Center sections (max 4) with their buttons, including inactive ones. Help sections are the cards residents see on the Help page.
- community.write
vlge_create_help_sectionCreate help sectionwriteAdds a Help Center card (title, short description, icon, up to 3 buttons). A community can have at most 4 sections; HELP_SECTION_LIMIT_REACHED means update or delete one instead. Visible to residents immediately.
- community.write
vlge_update_help_sectionUpdate help sectionwriteEdits a Help Center card. Only the fields you pass change; passing `buttons` replaces the whole button list. Set active=false to hide it from residents without deleting it.
- community.write
vlge_delete_help_sectionDelete help sectionwriteMoves a Help Center card to Rewind (soft delete; an admin can restore it for 45 days). Confirm the section title with the user first.
- community.read
vlge_list_pollsList pollsLists Poll Manager polls (draft, active, closed, archived) with response counts. Requires the manage-polls permission. When `truncated` is true, call again with the same filters and `offset` equal to the previous offset plus `count`.
- community.read
vlge_get_pollGet pollReturns one poll with its questions and response count.
- community.write
vlge_create_pollCreate pollwriteCreates a poll as a DRAFT with its questions. Nothing is visible to residents until it is activated with vlge_update_poll (status "active") and shared. Question types: multiple_choice (Select one option); checkbox (Select multiple options); yes_no (Simple yes or no); rating_scale (Rate on a scale); nps_scale (Net Promoter Score); short_text (Up to 140 characters); long_text (Up to 500 characters); number (Numeric input); date (Date picker); dropdown (Select from dropdown); ranking (Rank items in order).
- community.write
vlge_update_pollUpdate pollwriteEdits a poll. Set status "active" to open it to residents, "closed" to stop accepting responses, "archived" to hide it. Passing `questions` REPLACES every question and deletes any answers already recorded — only do that on drafts unless the user explicitly accepts losing responses.
- community.write
vlge_delete_pollDelete pollwriteSoft-deletes a poll (hidden immediately; an admin can restore it from Rewind for 45 days). Confirm with the user first.
- community.read
vlge_list_formsList formsLists Form Builder forms (resident-facing request/intake forms) with status and submission counts. When `truncated` is true, call again with the same filters and `offset` equal to the previous offset plus `count`.
- community.read
vlge_get_formGet formReturns one form with its fields.
- community.write
vlge_create_formCreate formwriteCreates a resident-facing form. Submissions are emailed to `recipient_email`. Saved as a draft by default (hidden from residents); pass draft=false to publish immediately — read the fields back to the user first when publishing. File-upload and instruction fields must be added in the app.
- community.write
vlge_update_formUpdate formwriteEdits a form's name, description, recipients, tags, draft/published state, or active flag. Passing `fields` REPLACES the field list — existing submissions keep their answers, but removed fields disappear from the form. Only fields you pass change.
- community.write
vlge_delete_formDelete formwriteDeletes a form. Forms that already have submissions are deactivated instead (submissions are kept); forms without submissions are soft-deleted and restorable from Rewind for 45 days. Confirm with the user first.
- community.read
vlge_list_binder_categoriesList binder categoriesLists Board Binder categories (e.g. Finance, Meetings, Vendors) for use as `category_id` when creating items.
- community.read
vlge_list_binder_itemsList binder itemsSearches the Board Binder. Returns summaries only; call vlge_get_binder_item for the full procedure text. Drafts are included only when the signed-in user can see them. When `truncated` is true, call again with the same filters and `offset` equal to the previous offset plus `count`.
- community.read
vlge_get_binder_itemGet binder itemReturns one Board Binder item with its full text and resources.
- community.write
vlge_create_binder_itemCreate binder itemwriteAdds a Board Binder item (PROCEDURE = how-to text; LINK / VIDEO / REFERENCE = resource-centric). Saved as a DRAFT unless status=PUBLISHED. Visible to the board only. Never store passwords or account numbers — the tool refuses with SECRET_WARNING when it spots one.
- community.write
vlge_update_binder_itemUpdate binder itemwriteEdits a Board Binder item. This is a full save: fetch the item first (vlge_get_binder_item), then pass every field with its current or new value — omitted optional fields are cleared. Set status=PUBLISHED to publish a draft; each published save records a revision. Requires edit-any permission or ownership of the item.
- community.write
vlge_archive_binder_itemArchive binder itemwriteMarks a Board Binder item ARCHIVED (kept for reference, hidden from the active list). Use vlge_update_binder_item with status=PUBLISHED to bring it back. Confirm with the user first.
- community.read
vlge_list_transition_plansList transition plansLists Transition Planner plans. Pass `plan_id` to get one plan expanded with its sections and items (statuses, owners, due dates, dependencies).
- community.write
vlge_create_transition_planCreate transition planwriteCreates an empty transition plan (e.g. "2027 board handover"). Add sections with vlge_create_transition_section, then items.
- community.write
vlge_update_transition_planUpdate transition planwriteRenames a plan, edits its description, or sets status (active, completed, archived).
- community.write
vlge_create_transition_sectionCreate transition sectionwriteAdds a section (e.g. "Banking", "Vendors", "Records") to a transition plan.
- community.write
vlge_create_transition_itemCreate transition itemwriteAdds a task to a transition plan section with optional owner, dates (YYYY-MM-DD), dependency, and status (New, To Do, In Progress, Delayed, Completed, Cancelled; default New).
- community.write
vlge_update_transition_itemUpdate transition itemwriteEdits a transition plan task — typically to change status, owner, or due date. Only fields you pass change; pass null for owner_user_id / depends_on_item_id / dates to clear them.
- community.read
vlge_list_email_draftsList email draftsLists community emails in the Messaging Center (drafts by default; pass status to see scheduled or sent ones) with audience and recipient counts. When `truncated` is true, call again with the same filters and `offset` equal to the previous offset plus `count`.
- community.read
vlge_get_email_draftGet email draftReturns one community email with its body text and audience.
- community.write
vlge_create_email_draftCreate email draftwriteDrafts a community email in the Messaging Center. It is NOT sent — tell the user to open Messaging Center → Drafts in Vlge to review and send it. Audience: `all` residents, `groups` (pass group_ids from vlge_list_groups), or `people` (pass user_ids from vlge_list_people). `body` may be plain text or HTML.
groups
- groups.read
vlge_list_groupsList groupsLists active community groups (committees, interest groups, board) with membership type and member counts, and whether the signed-in user is a member. When `truncated` is true, call again with the same filters and `offset` equal to the previous offset plus `count`.
- groups.read
vlge_list_group_membersList group membersLists the members of one group with their role (member or admin). Each row includes the member id needed by vlge_remove_group_member and the user id. When `truncated` is true, call again with the same group_id and `offset` equal to the previous offset plus `count`.
- groups.write
vlge_create_groupCreate groupwriteCreates a community group (committee, interest group). If the signed-in user can approve groups it becomes active immediately with them as the group admin; otherwise it is submitted for approval. `email_alias` becomes the group mailbox name (letters, numbers, hyphens); omitted = derived from the name.
- groups.write
vlge_update_groupUpdate groupwriteEdits a group's name, description, email alias, membership type, or email footer. Only fields you pass change. Membership type cannot change on system groups (Board).
- groups.write
vlge_archive_groupArchive groupwriteArchives a group so it disappears from the community (members, posts, and history are kept; an admin can see archived groups in Vlge). System groups cannot be archived. Confirm with the user first.
- groups.write
vlge_add_group_memberAdd group memberwriteAdds a community member to a group by user id (find it with vlge_list_people). Requires group admin access; system groups also require the manage-group-members permission.
- groups.write
vlge_remove_group_memberRemove group memberwriteRemoves a member from a group using the member id from vlge_list_group_members. The signed-in user may remove themselves; removing others requires group admin access.
