Ship safer agents with Flowtly MCP documentation

How to stay current

1. Run the sync command above after MCP updates ship.
2. Restart your agent stack to pick up capability changes.
3. Bookmark this page for the latest Flowtly MCP guidance.

What’s inside

• Auth and API key rules for MCP endpoints.
• Resource schemas for knowledge base, blog, releases, investors, and product updates.
• JSON-RPC payloads and write/read tips for agents.

Transport & Auth

• Endpoints: POST /mcp (JSON-RPC entry), GET /health (liveness), POST /api/chat (console proxy; requires Authorization: Bearer <token>)
• Headers: Authorization Bearer token (preferred; falls back to FLOWTLY_API_KEY), instance header optional and forwarded
• Content-Type: application/json
• Body: JSON-RPC 2.0 { "jsonrpc": "2.0", "id": "...", "method": "...", "params": {...} }

initialize

• Negotiates capabilities and namespaces.
• Example params: { "protocolVersion": "2024-11-05" }
• Returns capabilities (list, read, write) and namespaces (work-times, projects, employees, vacations, holidays, responsibilities, cost-groups, logical, project-rates, transactions, transaction-attachments, suppliers, organization, candidates, resource-requests).

resources/list

• Method: resources/{namespace}/list (default namespace: work-times when omitted)
• Namespaces include work-times, projects, employees, vacations, holidays, responsibilities, cost-groups, logical, project-rates, transactions, transaction-attachments, suppliers, organization, candidates, resource-requests.
• Returns URIs per namespace (see breakdown below).

resources/read

• Method: resources/{namespace}/read (default namespace: work-times).
• Params include uri, e.g., /api/work-times
• allowPrefixes enables cross-namespace matches; {current} resolves to /api/employees/me.
• Some resources add defaults (work-times adds date bounds; employees add itemsPerPage; holidays/vacations add pagination defaults).
• Responsibilities follow up to 10 @id links to enrich title/name.
• Logical namespace returns server-side summaries instead of raw payloads.
• Returns contents payload from the underlying Flowtly API.

resources/write

• Only resources with allowWrite accept writes; POST unless URI ends with an id (then PATCH with application/merge-patch+json).
• /api/.../create forces POST even if an id is present; override type via params.contentType.
• Logical write helper: resources/logical/write supports /logical/recruiting/resource-requests/update?id=<id> and /logical/recruiting/resource-request-candidates/update?id=<id> (PATCH).

Logical namespace (/logical/*)

• Read-only summaries: work-times, employees, projects, employee-work-times, project-rates, transactions, project-profitability.
• Recruiting summaries: company-onboarding/status, recruiting/open-roles, recruiting/candidates.
• Holidays summaries: logical/holidays.
• Example: /logical/work-times/summary supports date[after]/date[before] (defaults last 7 days).

Error shape

• { "jsonrpc": "2.0", "id": "...", "error": { "code": -32000, "message": "Upstream Flowtly API failed", "data": { "status": 502 } } }

Notes

• allowPrefixes lets resources/read accept URIs that start with allowed prefixes.
• OpenAPI-style reference available at public/mcp/openapi.json.

resources/list by namespace