FlowyTeam MCP Server Documentation

Connect Claude Code (CLI), n8n, or any MCP-compatible AI agent to your FlowyTeam workspace. No middleware. No custom code. Just plug in and start automating.

Open Standard

What is an MCP Server?

MCP (Model Context Protocol) is an open standard that lets AI agents talk directly to your tools. FlowyTeam ships as a native MCP Server — meaning your AI can read and write real data inside your workspace without any intermediary layer.

Capabilities

What Your AI Can Do

Auth Register

Create a new FlowyTeam company account. Only call this tool when the user explicitly requests account creation and provides all required details. Requires MCP registration to be enabled by the platform administrator. Password is optional — if omitted, a secure temporary password is generated and included in the verification email. A verification email with a 6-digit code is sent — ask the user to share the code, then call auth_verify_email to activate the account and receive the api_token immediately. Alternatively the user can click the verification link in the email to activate via the browser, then copy the api_token from FlowyTeam Settings → MCP & AI Integration.

POST
Auth Verify Email

Activate a newly registered FlowyTeam account and receive the api_token. Call this after auth_register once the user shares the 6-digit code from their verification email. Also accepts the long token from the verification link URL as a fallback. On success, the account is activated and an api_token is returned — use it as the Bearer token and reconfigure the MCP connection.

POST
Auth Login

Retrieve the api_token for an existing FlowyTeam account using email and password. Only call this tool when the user explicitly provides their credentials and requests a login — never proactively. Note: for new accounts use auth_register + auth_verify_email instead. Existing users can also copy their token directly from FlowyTeam Settings → MCP & AI Integration. Returns an api_token — reconfigure the MCP connection with it as the Bearer token.

POST
Tasks

Manage tasks: list, create, update, delete, mark complete. Filter by status, priority, project, assignee, due date.

GET POST PUT DELETE
Projects

Manage projects and their sub-resources (milestones, members, categories, files). Set resource=project (default), milestone, member, category, or file. All lookups are name-based — no IDs needed. Admins have full access. Members can view/update their own projects, and perform full CRUD on milestones, members, and files.

GET POST PUT DELETE
Task Category

Manage task categories: list, create, update, delete. Lookup by ID or category name.

GET POST PUT DELETE
Leave

Manage employee leave requests: list, create, approve, reject, cancel. Filter by status, employee, date range.

GET POST PUT DELETE
Leave Type

Manage leave types (annual, sick, etc.): list, create, update, delete. Admin-only for write operations.

GET POST PUT DELETE
Attendance

Manage attendance: clock-in, clock-out, list records. Filter by employee, date, month, year.

GET POST PUT
Employees

Manage employees: list, show full profile, create, update (profile/department/designation/status/skills), deactivate/delete. Always resolve by name or email — never require an ID from the user.

GET POST PUT DELETE
Department

Manage departments/teams: list, show details with members, create, update, delete, add/remove members. Always resolve by name — never require an ID from the user.

GET POST PUT DELETE
Designation

Manage job designations/positions: list (with member counts), create, update, delete. Always resolve by name — never require an ID from the user.

GET POST PUT DELETE
Clients

Manage clients: list, create, update, delete. Filter by name, company.

GET POST PUT DELETE
Tickets

Manage support tickets and their conversation replies. Supports full CRUD (list, create, update, delete), reply/conversation management (resource=reply), ticket statistics (action=stats), and close/reopen actions. Name-based lookups for agent, requester, type, and channel. Admins and privileged members have full access. Regular members can manage their own tickets (create, view, reply, close, reopen).

GET POST PUT DELETE
Ticket Type

Manage ticket types/classifications: list, create, update, delete. Lookup by name or ID.

GET POST PUT DELETE
Ticket Channel

Manage ticket channels (e.g. email, phone, chat): list, create, update, delete. Requires the tickets module.

GET POST PUT DELETE
Ticket Agent

List ticket agents and their assigned groups.

GET
Objectives

Manage OKR objectives: list, create, update, delete. Filter by cycle, type (company/team/personal), status.

GET POST PUT DELETE
Key Result

Manage OKR key results: list, create, update, delete, update progress. Link to objectives.

GET POST PUT DELETE
Indicators

Manage KPI indicators: list, create, update, delete. Filter by category, employee. Lookup by title or ID.

GET POST PUT DELETE
Indicator Category

Manage KPI indicator categories/types: list, create, update, delete. Lookup by name or ID.

GET POST PUT DELETE
Indicator Record

Manage KPI indicator records (actual values per period): list, add, delete. Lookup by indicator_id + period_key.

GET POST DELETE
Performance Cycle

Manage OKR performance cycles: list, create, update, delete. Lookup by name or ID.

GET POST PUT DELETE
Holiday

Manage company holidays: list, create, update, delete. Filter by year, upcoming/past. Lookup by ID or holiday name.

GET POST PUT DELETE
Leads

Manage sales leads: list, create, update, delete. Filter by status, agent, date range.

GET POST PUT DELETE
Invoices

Manage client invoices: list, create, update status, delete. Filter by client, status, date range.

GET POST PUT DELETE
Estimates

Manage client estimates/quotes: list, create, update, delete. Filter by client, status, date.

GET POST PUT DELETE
Events

Manage company events/calendar: list, create, update, delete. Filter by month, year, date range.

GET POST PUT DELETE
Expenses

Manage expenses and claims: list, create, update status (approve/reject), delete. Filter by employee, category, status, date range.

GET POST PUT DELETE
Expense Category

Manage expense categories: list, create, update, delete. Admin-only for write operations.

GET POST PUT DELETE
Notices

Manage notice board: list, create, update, delete. Filter by date range or audience (all/employee/client).

GET POST PUT DELETE
Contracts

Manage client contracts: list, create, update, delete. Filter by client, status, date range.

GET POST PUT DELETE
Timelogs

Manage project/task time logs: list, create (start timer), update (stop timer/edit), delete. Filter by project, employee, date.

GET POST PUT DELETE
Quick Setup

How to Connect

Connect your AI agent in minutes — whether you have an existing account or are signing up for the first time.

1

Generate your API Key

Go to Settings → API & Integrations in your FlowyTeam dashboard and create a new API key with the scopes you need.

2

Add the MCP config

Paste the JSON snippet below into your Claude Code MCP configuration (Claude Code CLI or project mcp.json). Note: Claude Desktop is not supported.

Option A — with API token (existing account)

Claude Code CLI

claude mcp add --transport http flowyteam \
  https://flowyteam.com/api/v2/mcp/rpc \
  -H "Authorization: Bearer YOUR_API_TOKEN"

~/.claude/mcp.json (Claude Code project config)

{
  "mcpServers": {
    "flowyteam": {
      "transport": "http",
      "url": "https://flowyteam.com/api/v2/mcp/rpc",
      "headers": { "Authorization": "Bearer YOUR_API_TOKEN" }
    }
  }
}

Option B — Existing account, no token handy

Go to FlowyTeam → Settings → MCP & AI Integration → copy your API token, then use Option A above.

Can't access the settings page yet? Connect to the Gateway endpoint and ask Claude to log you in:

Step 1 — Connect to Gateway

claude mcp add --transport http flowyteam \
  https://flowyteam.com/api/mcp/gateway

Step 2 — Ask Claude to retrieve your token

"Get my FlowyTeam API token — my email is [email protected] and my password is ••••••••"

Claude retrieves your api_token. Reconnect using Option A with that token.

Option C — Create a new account via Gateway

No account yet? Ask Claude to register one. Password is optional — if you skip it, a secure temporary password is generated and included in your verification email. You can change it after your first login.

Step 1 — Connect to Gateway & register

"Register a new FlowyTeam account — name: Alice Smith, email: [email protected], company: Acme Corp"

Claude calls auth_register. A verification email is sent — it includes your temporary login password if you didn't set one.

Step 2 — Verify your email (choose one path)

Path A — Paste 6-digit code to Claude Code CLI

Open the verification email and copy the 6-digit code from the email body.

Then tell Claude: "verify my email with code 123456"

Claude calls auth_verify_email and returns your api_token immediately.

Path B — Click link in browser

Click the verification link in the email to activate your account in the browser.

Then go to FlowyTeam → Settings → MCP & AI Integration → copy your api_token and reconnect using Option A.

Reconnect using Option A with the returned token.

3

Start a new Claude Code session

Open a new Claude Code chat session. FlowyTeam tools will be available automatically — just ask Claude to use them.

Important Notice

Claude Code Only — Claude Desktop Not Supported

FlowyTeam MCP Server currently only works with Claude Code (the CLI tool). It is NOT compatible with Claude Desktop. Please make sure you are using the Claude Code command-line tool when connecting.

Integrations

Compatible AI Clients

FlowyTeam's MCP Server has been verified with Claude Code (CLI). Support for other MCP clients is coming soon.

Claude Code
Claude Code

CLI Tool (Supported)

FlowyTeam
ChatGPT

OpenAI

FlowyTeam
n8n

Workflow Automation

FlowyTeam
Cursor

AI Code Editor

Ready to connect your AI?

Create your free FlowyTeam account and have your first AI agent running in under five minutes.