Skip to content

docs: add FLUJO remote client guide #3248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
flujo-app wants to merge 1 commit into
base: main
Choose a base branch
from
+31 −0
Open

docs: add FLUJO remote client guide #3248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/installation-guides/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ This directory contains detailed installation instructions for the GitHub MCP Se
- **[Claude Applications](install-claude.md)** - Installation guide for Claude Desktop and Claude Code CLI
- **[Cline](install-cline.md)** - Installation guide for Cline
- **[Cursor](install-cursor.md)** - Installation guide for Cursor IDE
- **[FLUJO](install-flujo.md)** - Manual remote setup with a secret Bearer header and read-only repository tools
- **[Google Gemini CLI](install-gemini-cli.md)** - Installation guide for Google Gemini CLI
- **[OpenAI Codex](install-codex.md)** - Installation guide for OpenAI Codex
- **[OpenCode](install-opencode.md)** - Installation guide for the OpenCode terminal agent
Expand All @@ -30,6 +31,7 @@ This directory contains detailed installation instructions for the GitHub MCP Se
| Claude Desktop | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Moderate |
| Cline | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Easy |
| Cursor | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Easy |
| FLUJO | Not tested | Bearer header (read-only repository tools verified) | FLUJO, authorized GitHub access token | Easy |
| Google Gemini CLI | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Easy |
| OpenCode | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Easy |
| Roo Code | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Easy |
Expand Down
29 changes: 29 additions & 0 deletions docs/installation-guides/install-flujo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Remote GitHub MCP server in FLUJO

Connect [FLUJO](https://flujo.com.co/) to the hosted GitHub MCP server and verify a repository read using its built-in tool tester. This guide covers a manual Bearer header and the read-only repository toolset.

## Prerequisites

- A running FLUJO instance.
- A GitHub access token authorized to read the repository you want to test. The recorded validation used the token from an existing authorized GitHub CLI session, available with `gh auth token`. Paste the token only into the secret header field below.

See the [remote server documentation](../remote-server.md) for authentication and toolset options.

## Connect and test

1. In FLUJO, open **Connected Apps > Connect App > I have connection details > At a remote URL**.
2. Enter `https://api.githubcopilot.com/mcp/x/repos/readonly` and select **Connect**.
3. Select **Continue to setup**. The initial test without a header will report that authentication is required.
4. Under **Custom HTTP headers**, select **Add header**. Set **Header** to `Authorization`, enable **Secret**, then enter `Bearer YOUR_ACCESS_TOKEN` as the value. Replace the placeholder with your token.
5. Leave the OAuth client fields blank for this manual-header route. Select **3) Test run**.
6. After the MCP handshake passes and tools are discovered, select **Update server**.
7. Open the saved server's **Tools** tab and choose `get_file_contents`.
8. Enter the repository's `owner`, `repo`, and file `path`, then select **Test tool**. The result should contain the requested file.

The endpoint restricts the exposed tools to repository reads. Token permissions still determine which repositories can be read; use only the permissions needed for your task.

## Validation scope

FLUJO 3.45.2 completed the authenticated handshake, discovered 13 tools, and retrieved a public text fixture through this route. The test supplied a GitHub CLI OAuth access token as a secret Bearer header; it did not test FLUJO's interactive OAuth flow or PAT-specific behavior.

Local-server setup and other toolsets are not covered here. Interactive OAuth requires a registered GitHub App or OAuth app, as explained in the [host support notes](README.md#support-by-host-application).