@flowrelay/mcp-server 1.0.23 → 1.0.25

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,6 +1,8 @@
1
1
  # Flow Relay MCP Server
2
2
 
3
- Flow Relay MCP Server adds project-aware, multi-tenant Flow Relay tools to MCP clients such as Claude Desktop and Claude Code.
3
+ [![M8ven Verified](https://m8ven.ai/badge/mcp/atrisorb/flowrelay-mcp-server?variant=verified)](https://m8ven.ai/mcp/atrisorb/flowrelay-mcp-server)
4
+
5
+ Flow Relay MCP Server adds project-aware, multi-tenant Flow Relay tools to MCP clients such as Claude Desktop, Claude Code, Cursor and Windsurf.
4
6
 
5
7
  It connects to Flow Relay API v1 using an API key and supports:
6
8
 
@@ -9,47 +11,71 @@ It connects to Flow Relay API v1 using an API key and supports:
9
11
  ## Package
10
12
 
11
13
  - Name: @flowrelay/mcp-server
12
- - Version: 1.0.16
14
+ - Version: 1.0.25
15
+
16
+ ## Supported Sources (46 Integrations)
17
+
18
+ Flow Relay MCP Server supports 46 integration sources across the entire engineering lifecycle:
19
+
20
+ - **Code & Version Control**: `github`, `gitlab`, `bitbucket`, `azure_devops` (support branch filtering)
21
+ - **CI/CD & Deployment**: `buildkite`, `circleci`, `vercel`, `netlify`, `render`, `railway`, `cloudflare_pages`
22
+ - **Issue Tracking & Project Management**: `linear`, `jira`, `clickup`, `monday_com`, `shortcut`, `asana`
23
+ - **Observability & Incidents**: `sentry`, `datadog`, `pagerduty`, `incident_io`, `grafana`, `new_relic`
24
+ - **Product Analytics**: `posthog`
25
+ - **Security & Code Quality**: `snyk`, `sonarqube`
26
+ - **Feature Flags & Infrastructure**: `launchdarkly`, `hcp_terraform`
27
+ - **Meetings & Collaboration**: `fireflies`, `zoom`, `google_calendar`, `miro`
28
+ - **Customer Support**: `intercom`, `zendesk`, `jira_service_management`
29
+ - **CRM**: `hubspot`, `salesforce`
30
+ - **Communication & Email**: `slack`, `discord`, `microsoft_teams`, `microsoft_outlook`, `gmail`
31
+ - **Documents & Design**: `notion`, `confluence`, `google_drive`, `figma`
13
32
 
14
33
  ## What Is Included
15
34
 
16
- The server currently exposes these tools:
17
-
18
- - get_workspace_context
19
- - list_projects
20
- - set_active_project
21
- - list_filter_options (lists the selectable resources, branches, event types and priorities per source for a project – call this before generating so handoff/insight filters use real values instead of guesses; also reports whether Figma is selectable, since Figma requires the project's processing region to be Global)
22
- - list_handoffs (returns project-specific handoffs, or an aggregated view of all accessible project handoffs if no project is active; filter by status: active, archived, or all)
23
- - ask_project (ask a question about a project and get an answer grounded in codebase, baselines and 14 days of activity; 2 credits per question)
24
- - generate_handoff (processed asynchronously, and the server automatically polls until the job finishes. Requires active project or project_id. Accepts per-source filters: projects, eventTypes, branches, priorities.)
25
- - generate_correlation_insight (accepts per-source filters)
26
- - generate_onboarding_brief (accepts per-source filters)
27
- - generate_architecture_insight (accepts per-source filters)
28
- - generate_release_notes (generates release notes or PR descriptions from code activity; accepts per-source filters)
29
- - list_digests (lists past scheduled activity digests for a project)
30
- - list_insights
31
- - list_integrations
32
- - list_events
33
- - list_untracked_resources (lists event-producing resources not scoped to any project – useful for discovering untracked activity)
34
- - discord_list_channels
35
- - discord_send_message (plain text, or a handoff/insight by id or `last_*` – `last_handoff`, `last_correlation`, `last_onboarding`, `last_architecture`, `last_release_notes` – rendered to Markdown and attached as a `.md` file)
35
+ The server currently exposes 18 tools. Every tool carries the four MCP annotations (`readOnlyHint`, `destructiveHint`, `idempotentHint`, `openWorldHint`): the `list_*` and `get_*` tools are read-only and idempotent, the `generate_*` tools, `ask_project` and `discord_send_message` are non-idempotent (each call spends credits or posts a message) and no tool is destructive.
36
+
37
+ - `get_workspace_context`: Show current Flow Relay context (account mode, organizations count, accessible projects count, active project scope and caller role).
38
+ - `list_projects`: List every accessible project (personal and organization) with id, scope and role.
39
+ - `set_active_project`: Set or clear the active project for subsequent tool calls so `project_id` can be omitted.
40
+ - `list_filter_options`: List selectable resources (projects/repos/channels/boards), branches, event types and priorities per source for a project. Call this before generating so handoff and insight filters use real values instead of guesses. Also reports whether Figma visual context is selectable (requires Global processing region).
41
+ - `list_handoffs`: List handoffs for the active project or across accessible projects. Filter by status (`active`, `archived` or `all`). Outputs server-rendered Markdown.
42
+ - `generate_handoff`: Generate an async handoff with automated polling until completion. Requires active project or explicit `project_id`. Accepts per-source `filters` (`projects`, `eventTypes`, `branches`, `priorities`).
43
+ - `generate_correlation_insight`: Generate a cross-source correlation insight. Accepts per-source `filters`.
44
+ - `generate_onboarding_brief`: Generate an onboarding brief insight. Accepts per-source `filters`.
45
+ - `generate_architecture_insight`: Generate an architecture insight. Accepts per-source `filters`.
46
+ - `generate_release_notes`: Turn a project's merged work into release notes or a PR description (`style: 'release_notes' | 'pr_description'`). Accepts code source, repo and per-source `filters`. Costs 3 credits per run.
47
+ - `ask_project`: Ask one question about a project and get an answer grounded in its indexed codebase, baselines and last 14 days of activity. Answers synchronously and cites used events (`ev:...`). Costs 2 credits per question.
48
+ - `list_digests`: Browse scheduled activity digests of a project, newest first. Reading is free.
49
+ - `list_insights`: List project AI insights by kind and status.
50
+ - `list_integrations`: List connected integrations in personal or project scope.
51
+ - `list_events`: Browse recent events in personal or project scope.
52
+ - `list_untracked_resources`: List event-producing resources not scoped to any project (useful for discovering unassigned activity).
53
+ - `discord_list_channels`: List text channels in connected Discord servers.
54
+ - `discord_send_message`: Send a Discord message – plain text, or attach a rendered Markdown artifact (`last_handoff`, `last_correlation`, `last_onboarding`, `last_architecture` or `last_release_notes`) as a `.md` file.
55
+
56
+ ### Filter Dimensions
57
+
58
+ When calling `generate_handoff`, insight tools or `generate_release_notes`, per-source `filters` accept:
59
+
60
+ - `projects`: Resource ids from `list_filter_options[source].projects` (repos, channels, boards, spaces, services, sites, projects).
61
+ - `eventTypes`: Event-type values from `list_filter_options` (e.g. `push`, `issue_created`, `workflow_job`).
62
+ - `branches`: Git branch names (`main`, `develop`) – git sources only (`github`, `gitlab`, `bitbucket`, `azure_devops`).
63
+ - `priorities`: Priority values – supported on `jira`, `linear`, `sentry`, `pagerduty`, `incident_io`, `clickup`, `zendesk`, `snyk` and `grafana`.
36
64
 
37
65
  ## Environment Variables
38
66
 
39
67
  Required:
40
68
 
41
- - FLOWRELAY_API_KEY
69
+ - `FLOWRELAY_API_KEY`: Your Flow Relay API key (`fr_...`).
42
70
 
43
71
  Optional:
44
72
 
45
- - FLOWRELAY_PROJECT_ID
46
- - FLOWRELAY_BASE_URL
47
-
48
- If FLOWRELAY_PROJECT_ID is set, it becomes the default project context for project-aware tools unless you override it per call.
73
+ - `FLOWRELAY_PROJECT_ID`: Initial active project context for project-aware tools.
74
+ - `FLOWRELAY_BASE_URL`: Base URL of the Flow Relay API (defaults to `https://www.flowrelay.it`).
49
75
 
50
76
  ## Quick Start (Claude Desktop)
51
77
 
52
- Add this to your claude_desktop_config.json:
78
+ Add this to your `claude_desktop_config.json`:
53
79
 
54
80
  ```json
55
81
  {
@@ -69,15 +95,16 @@ Add this to your claude_desktop_config.json:
69
95
  ## Multi-Tenant Behavior
70
96
 
71
97
  - Every handoff and insight is tied to a project; you need an active project (`set_active_project`) or `project_id`. Events and integrations remain user-level.
72
- - You can select a project during the MCP session with set_active_project.
73
- - You can override scope per call by passing project_id where supported.
98
+ - You can select a project during the MCP session with `set_active_project`.
99
+ - You can override scope per call by passing `project_id` where supported.
74
100
 
75
101
  Recommended flow:
76
102
 
77
- 1. Call get_workspace_context
78
- 2. Call list_projects
79
- 3. Call set_active_project
80
- 4. Run handoff and query tools in the selected scope
103
+ 1. Call `get_workspace_context`
104
+ 2. Call `list_projects`
105
+ 3. Call `set_active_project`
106
+ 4. Call `list_filter_options` to inspect selectable resources
107
+ 5. Run handoff, insight, Q&A and query tools in the selected scope
81
108
 
82
109
  ## Local Development
83
110
 
@@ -86,8 +113,11 @@ From this folder:
86
113
  ```bash
87
114
  npm install
88
115
  npm run build
116
+ npm test
89
117
  ```
90
118
 
119
+ `npm test` runs the suite in `tests/` with Node's built-in runner: it drives the server through an in-memory MCP client against a stub Flow Relay API, so it needs no API key and no network.
120
+
91
121
  Create a tarball package:
92
122
 
93
123
  ```bash
@@ -96,16 +126,17 @@ npm pack
96
126
 
97
127
  ## Troubleshooting
98
128
 
99
- - Error: Missing FLOWRELAY_API_KEY
100
- - Set FLOWRELAY_API_KEY in your MCP client configuration.
129
+ - Error: Missing `FLOWRELAY_API_KEY`
130
+ - Set `FLOWRELAY_API_KEY` in your MCP client configuration.
101
131
  - Project not found or inaccessible
102
- - Run list_projects and use one of the returned IDs.
132
+ - Run `list_projects` and use one of the returned IDs.
103
133
  - No events or handoffs returned
104
134
  - Verify active scope and data availability in that scope.
105
135
 
106
136
  ## Related Docs
107
137
 
108
138
  - Documentation & Platform: https://www.flowrelay.it
139
+ - MCP Documentation: https://www.flowrelay.it/docs/mcp
109
140
 
110
141
  ## License
111
142