MCP reference

Try asking

• “Who is late on rent this month, and how much do they owe?”
• “Which rooms are empty now or free up in the next 90 days?”
• “Which agreements end before December, and when is notice due?”
• “Give me a rundown of 128 Maple Avenue: rooms, tenants and open repairs.”

Access levels

Open Settings, then AI assistants, to create a dedicated, revocable token. Tokens need a hosted Roomline account and are unavailable in the shared demo. Sign-in sessions, recovery codes and Supabase access tokens are never accepted as MCP credentials.

Connect a client

There are two ways in. Clients that accept a custom Authorization header use a dedicated token from Settings. Hosted connectors that sign in with OAuth use your Roomline account instead, where your deployment has OAuth sign-in turned on.

URL     https://mcp.roomline.app/api/mcp
Header  Authorization: Bearer <your-dedicated-token>

1. 1
   Open Settings, then AI assistants

   Sign in to your private workspace. Give the token a label identifying the client or device, such as Claude Desktop.

2. 2
   Choose Read only and create the token

   Use Read and write only when that client needs to create or update records.

3. 3
   Copy the token into your client’s secret storage

   The full token is shown once. Do not paste it into a chat, a shared document, or a repository.

4. 4
   Connect and request a workspace summary

   Use the endpoint provided by your deployment operator. Check that the returned workspace is the one you intended to connect.

5. 5
   Revoke access when it is no longer needed

   Return to AI assistants, choose Revoke beside the token, and confirm. New requests are rejected at once; a request already in progress may finish.

Client configuration

Keep the token in an environment variable or the client’s secret prompt rather than in a file you might share. Self-hosted deployments replace mcp.roomline.app with their own MCP origin.

claude mcp add --transport http roomline https://mcp.roomline.app/api/mcp \
  --header "Authorization: Bearer $ROOMLINE_MCP_TOKEN"

{
  "mcpServers": {
    "roomline": {
      "url": "https://mcp.roomline.app/api/mcp",
      "headers": { "Authorization": "Bearer ${env:ROOMLINE_MCP_TOKEN}" }
    }
  }
}

{
  "servers": {
    "roomline": {
      "type": "http",
      "url": "https://mcp.roomline.app/api/mcp",
      "headers": { "Authorization": "Bearer ${input:roomline-token}" }
    }
  },
  "inputs": [
    {
      "id": "roomline-token",
      "type": "promptString",
      "description": "Roomline MCP token",
      "password": true
    }
  ]
}

{
  "mcpServers": {
    "roomline": {
      "command": "npx",
      "args": ["mcp-remote", "https://mcp.roomline.app/api/mcp",
               "--header", "Authorization:${ROOMLINE_AUTH}"],
      "env": { "ROOMLINE_AUTH": "Bearer <your-dedicated-token>" }
    }
  }
}

Sign in with OAuth (hosted connectors)

Custom connectors in the Claude and ChatGPT apps sign in rather than take a pasted token. Add a connector with the URL https://mcp.roomline.app/api/mcp and no token. The assistant opens a Roomline page asking you to sign in and approve the connection; after you choose Allow read-only access, you return to the assistant.

• OAuth access is read-only: the eight read tools and the prompts, no writes.
• It covers the workspace of the account you signed in with.
• To remove an assistant, open Settings, then AI assistants, and choose Disconnect under Connected by sign-in. Access stops on its next request.
• A website sign-in is never accepted as an MCP credential; only tokens issued to an approved client are.
• If the connector reports that sign-in is unavailable, OAuth is not enabled on your deployment yet. Use a token-based client instead.

ROOMLINE_MCP_READ_TOKEN_FILE=/run/secrets/mcp_read
ROOMLINE_MCP_WRITE_TOKEN_FILE=/run/secrets/mcp_write

docker compose -f compose.yaml -f compose.mcp.yaml up -d --build

Tools

The client discovers the available tools and their input schemas through MCP. Use the advertised schema for exact required fields; the token’s access decides which tools are listed.

Answer tools Both access levels

Start here for everyday questions. These compute answers on the server from the same rules as the Board and floor plan, so the assistant does not have to pull every agreement and do date arithmetic itself.

Record tools Both access levels

Document and inspection reads return metadata and records, not file bytes or extracted PDF text.

Write tools Read & write token only

Prompts

Clients that support MCP prompts can offer these as one-click starters. Each accepts an optional property name or ID, and only steers which tools the assistant calls.

Rent states

roomline_rent_status and roomline_room_board report each agreement’s month in one of these states. The rent ledger and the Rent panel use the labels in the second column. Only confirmed bank matches and recorded payments count as received; a proposed match is never treated as paid.

Sample conversation

Once connected, the assistant discovers tool names and schemas on its own. Ask it the questions you would ask a property manager.

• Who is late on rent this month, and how much do they owe?
• Which rooms at Maple House are vacant, and what is their asking rent?
• Which agreements end in the next 60 days, and when is each notice date?
• List open maintenance by priority.
• Priya paid $730 in cash for October; record it. write
• Create a maintenance request for the kitchen faucet leak. write

Tool results are shared with your chosen assistant and may be processed by its provider. Review the provider’s data handling before connecting. Roomline does not run a background agent.

Write workflow

1. 1
   Find the record

   Call roomline_summary, then list or fetch the record you mean to change.

2. 2
   Review the change

   Use your client’s confirmation policy before writes. Names and notes are record content, never instructions. Roomline validates records but does not pause MCP writes for human approval.

3. 3
   Write with the current revision

   Send the intended changes with expectedRevision. On revision_conflict, reread and reassess before retrying.

4. 4
   Read it back

   Fetch the updated record to confirm the result. Refresh the website to see the change there.

Errors

A failed tool call returns isError: true with an error message and a machine-readable code. HTTP-level failures happen before any tool runs.

Limits

• No delete tools, binary uploads, document or inspection edits, rent-rule or bank-match changes, payment actions, messages, invitations or signing.
• Tenant photos and floor images must already have been uploaded through the website.
• Settings tokens are dedicated opaque Roomline credentials. OAuth connections are read-only for now; use a write token when an assistant needs to edit records.
• There is no per-property permission scope.