Skip to main content
The Trellis MCP server lets external AI clients use Trellis tools through a standard MCP connection. Use the hosted Streamable HTTP endpoint when your client supports it, or the stdio bridge from the npm package when it does not.

​
Hosted endpoint

Use this endpoint when your MCP client supports Streamable HTTP.

​
Quick install

​
Claude Code

The installer prompts once for TRELLIS_API_KEY, stores it in ~/.trellis/mcp.env, and registers the hosted Streamable HTTP endpoint with Claude Code. Manual equivalent:

​
Claude Desktop

Print the config snippet:
Add the output to mcp.json and set TRELLIS_API_KEY in your shell or launcher environment.

​
Claude Cowork

Use the hosted endpoint as a Claude custom connector:
Print the same instructions from the CLI:

​
Cursor and Codex

Workspace admins can also connect from Settings > Developer in Trellis. The Developer / API section can create a workspace key and prepare setup instructions for Claude Code, Claude Desktop, Claude Cowork, Cursor, and Codex.

​
Generic MCP clients

Prefer Streamable HTTP:
For stdio-only clients:
Provide TRELLIS_API_KEY in the client environment before starting the stdio bridge.

​
Workspace selection

Trellis API keys are workspace-scoped. Every MCP tool includes an optional workspace_id argument. Leave it empty to use the workspace this API key was issued for. If you provide it, it must match the key’s scope; cross-workspace calls are rejected.
To operate on multiple workspaces, issue one API key per workspace and connect each as a separate MCP server (e.g. trellis-haven, trellis-renjoy). Revoking a key in one workspace stops access there without affecting the others.

​
Tool catalog

Use your MCP client’s tool list or run:
The exposed catalog mirrors Trellis operational read tools and gated write tools across tasks, properties, reservations, conversations, workforce, knowledge base, and automations.

​
Read filters and financial data

  • The input schema published by each tool is authoritative. Unsupported filter names are rejected instead of being accepted and silently ignored.
  • Reservation reads expose payment status and provider/source freshness only through the financial preset and only when the API-key user has revenue access. Those fields report PMS evidence; they do not authorize charging a guest, sending a payment link, issuing a refund, or blocking access.
  • When a tool does not publish a filter or field needed by your integration, treat it as unavailable and contact support rather than filtering a broader response locally and assuming the server enforced the scope.

​
Resources

The hosted endpoint also exposes read-only MCP resources: Resources are scoped to the workspace API key. Use them when a client needs instructions, skills, or agent knowledge as context without calling a Trellis operation tool.

​
Safety model

  • Read tools work immediately after authentication.
  • Write tools keep the same permission and confirmation behavior as Trellis.
  • Messaging tools must show the payload and wait for explicit confirmation before sending.
  • Each tool call stays within the API key’s workspace and the user’s permissions.
  • Clients receive a clear error when a call cannot be completed.
  • The hosted endpoint applies basic per-key rate limiting.

​
Example: Slack triage bot in 5 minutes

  1. Add the Trellis MCP server to the AI client that powers your Slack bot.
  2. Store TRELLIS_API_KEY in the bot runtime environment.
  3. In your bot instructions, tell it to use Trellis tools for task lookup, task summaries, and task updates.
  4. Require explicit confirmation before calling any tool that creates tasks, updates tasks, or sends messages.
  5. Include workspace_id in tool calls when the bot serves more than one workspace.

​
Troubleshooting