Skip to content
Bayan FlowBayan Flow
Get started

Documentation · MCP connector

Connect your AI apps to your Bayan Flow knowledge

Search your company knowledge, write and update documents, and review your workspace from Claude, ChatGPT or any MCP app. You sign in with your Bayan Flow account, choose what the app may do, and stay in control.

  • OAuth 2.0 with PKCE
  • Remote MCP · Streamable HTTP
  • Owner approval for risky changes

Server address

https://bayanflow.tech/api/v1/mcp

Paste this address into your AI app as a custom MCP connector. There is nothing else to copy.

What AI apps can do with Bayan Flow

Bayan Flow turns a company’s own documents into accurate answers for its support team. This MCP connector lets AI apps such as Claude and ChatGPT work with the knowledge bases and the workspace you choose, with your permissions and nothing more.

  • Answer from your own documents

    The app searches the knowledge bases you allow and reads the passages, so its answers come from your policies and product information instead of guesses.

  • Keep knowledge up to date

    Create knowledge bases and documents, and save edits as new versions. Nothing is ever deleted this way.

  • Understand your workspace

    See members (with masked e-mail), teams, usage and the activity log. No secrets and no payment data are ever shown.

  • The app proposes, you decide

    The app can propose adding or removing members, changing roles, editing settings or deleting knowledge. Every proposal waits for the workspace owner, who approves it in Bayan Flow with their password.

Things you can ask your AI app

  • Search my Bayan Flow knowledge for our refund policy and summarise it in three bullet points.
  • Which documents mention delivery times? List them with the knowledge base each one is in.
  • Create a document called “Returns checklist” in the Help Center base with the steps we just agreed.
  • Show this month’s usage and the last ten entries of the activity log.
  • Propose removing the member who left the company. I will approve it in Bayan Flow.

Connect Claude in three steps

This is for Claude.ai and Claude Desktop. There is no key to copy: you sign in to Bayan Flow and approve the connection.

You need a Bayan Flow account that is a workspace owner, or an admin whom the owner allowed to manage integrations. Anyone else will see that they cannot connect an app and can ask the owner.

  1. Add the connector in Claude

    Open Settings → Connectors → Add custom connector, paste the server address below and save.

    https://bayanflow.tech/api/v1/mcp

  2. Press Connect

    A Bayan Flow page opens in your browser. Sign in if you are asked to.

  3. Choose the workspace and the permissions

    Pick the workspace, tick what Claude may do and press Allow. Anything beyond reading asks for your password, and you return to Claude automatically.

Start a new chat and ask: “Search my Bayan Flow knowledge for the refund policy.”

Claude Code

Add the server, then run /mcp inside Claude Code and choose Authenticate. It opens the same approval page.

claude mcp add --transport http bayan-flow https://bayanflow.tech/api/v1/mcp

Clients that cannot open a sign-in page

For Cursor, VS Code or a script, create an MCP key in Integrations → MCP and send it as a bearer header. Keep it in an environment variable, never in a shared file.

Authorization: Bearer $BAYAN_MCP_KEY

To disconnect, open Integrations → MCP in Bayan Flow and revoke the connection. The app loses access at once.

ChatGPT and other AI apps

Any app that supports remote MCP servers over HTTPS can connect. Apps that offer OAuth sign-in use the same one-link flow as Claude. Menu names differ between apps and change over time: look for “custom connector”, “developer mode” or “add MCP server”.

ChatGPT

Available on the paid ChatGPT plans that allow custom MCP connectors. In a business workspace an admin may have to allow it first.

  1. In ChatGPT’s settings, turn on developer mode (look under Connectors or Security).
  2. Create a new connector (or app): paste the server address and choose OAuth as the authentication. No client ID or secret is needed, because ChatGPT registers itself.
  3. Press Connect. A Bayan Flow page opens: choose the workspace and the permissions, then press Allow.
https://bayanflow.tech/api/v1/mcp

Other apps with OAuth

Paste the server address and leave the authentication on OAuth or automatic. The app registers itself and sends you to the Bayan Flow approval page.

Apps that only run local servers

Use the mcp-remote helper (needs Node.js), which turns a remote server into a local one. Ready-made snippets are in Integrations → MCP.

Apps that use a key

Cursor, VS Code, Windsurf, Gemini CLI, Codex CLI and similar tools accept a custom header. Create an MCP key in Integrations → MCP and keep it in an environment variable. The setting names differ slightly between apps; the address and the header are what matter.

{
  "mcpServers": {
    "bayan-flow": {
      "url": "https://bayanflow.tech/api/v1/mcp",
      "headers": { "Authorization": "Bearer ${BAYAN_MCP_KEY}" }
    }
  }
}

The approval page shows the app’s name and the address it will return to. Apps from Anthropic and OpenAI are marked as verified; for any other app, check the address before you allow.

Tools

25 tools, all listed below. Each has a title and is marked read-only or not, so the app and its users can tell what a tool does before it runs.

ReadTools that only look

Nothing is changed and no credits are spent.

  • knowledge_list_basesknowledge:read

    Lists the knowledge bases this key may read, with their access level and document count.

  • knowledge_searchknowledge:read

    Searches your knowledge and returns the best passages with their sources. Retrieval only: no AI text, no credits.

  • knowledge_list_documentsknowledge:read

    Lists the documents of one knowledge base.

  • knowledge_get_documentknowledge:read

    Reads the text of one document, page by page.

  • workspace_getworkspace:read

    The workspace’s name, languages, plan and seat use.

  • workspace_list_membersworkspace:read

    Members with their role and status. E-mail addresses are masked.

  • workspace_list_teamsworkspace:read

    Teams and how many members each has.

  • workspace_usageworkspace:read

    Request, credit and activity totals for recent days.

  • workspace_audit_logworkspace:read

    Recent entries of the activity log: who did what, never the content.

  • workspace_list_pending_actionsworkspace:read

    The changes keys proposed and what became of them.

  • store_order_statusworkspace:read

    The status of one order of the connected store: shipping, tracking, items, total. Never customer details.

WritesTools that write knowledge

They create or edit knowledge. Edits are saved as new versions and nothing is deleted.

  • knowledge_create_baseknowledge:write

    Creates a company knowledge base. Not for keys limited to chosen bases.

  • knowledge_create_documentknowledge:write

    Adds a new document to a knowledge base. It is indexed in the background.

  • knowledge_update_documentknowledge:write

    Saves new text as a new version. Older versions are kept, nothing is deleted.

Needs approvalTools that propose changes

They never change anything themselves. They create a proposal that the workspace owner approves or rejects in Bayan Flow.

  • knowledge_delete_documentworkspace:admin

    Proposes deleting a document. Nothing is deleted until the owner approves.

  • knowledge_archive_baseworkspace:admin

    Proposes archiving a knowledge base, so it stops serving answers.

  • member_inviteworkspace:admin

    Proposes inviting a person by e-mail. Sent only after approval.

  • member_change_roleworkspace:admin

    Proposes changing a member’s role to admin or member. Never the owner.

  • member_disableworkspace:admin

    Proposes disabling a member: they lose access and the seat is freed.

  • member_removeworkspace:admin

    Proposes removing a member from the workspace.

  • team_createworkspace:admin

    Proposes creating a team.

  • team_updateworkspace:admin

    Proposes renaming a team or changing its description.

  • team_deleteworkspace:admin

    Proposes deleting a team.

  • team_set_membersworkspace:admin

    Proposes replacing the member list of a team.

  • workspace_update_settingsworkspace:admin

    Proposes changing the name, languages or what admins may do. Never integrations or billing.

The app sees only the tools your permissions allow. If a tool is missing, connect again and tick more permissions.

Permissions

You choose them on the approval page. A connection can never do more than you ticked, and you can revoke it at any time.

  • Read knowledge

    knowledge:read

    Search and read the knowledge bases the key may use. Nothing is changed and no credits are spent.

    One click to allow.

  • Write knowledge

    knowledge:write

    Create knowledge bases and documents, and save edits as new versions. Never deletes anything.

    Asks for your password.

  • Read the workspace

    workspace:read

    See members (names, roles, masked e-mail), teams, usage and the activity log. No secrets and no payment data.

    One click to allow.

  • Propose workspace changes

    workspace:admin

    Propose changes to members, teams, settings and deletions of knowledge. Each one waits for the owner’s approval.

    Workspace owners only, asks for your password, and every change still needs the owner’s approval.

Security and privacy

The connector is built so that a mistake, a leaked token or a misbehaving assistant has a small blast radius.

  • Sign-in you control

    OAuth 2.0 authorization code with PKCE. The app never sees your password and Bayan Flow never sees the app’s credentials. The approval page shows the app’s name and the address it will return to.

  • Only what you allow

    A connection is limited to one workspace and the permissions you ticked. The person who approved it must still manage integrations there, or the connection stops.

  • Owner approval

    Risky changes are only proposals. The owner approves with their password; 5 wrong tries lock approving for 15 minutes, and a proposal nobody decides expires after 24 hours.

  • Short-lived access

    Access tokens last one hour and renew automatically. If a copy of a renewal token is ever used a second time, the whole connection is cancelled.

  • Revoke any time

    Revoke the connection from Integrations → MCP, or from the app. Waiting proposals are rejected and access stops immediately.

  • An audit trail

    Bayan Flow records which tool was called and how it ended, never the content. The workspace owners also receive an e-mail when a connection is made.

Your data

Passages that the app asks for are sent to that app’s provider and handled under the terms of your plan with them, so connect only assistants your company trusts with them. Text from your documents is marked as data, not instructions, to resist prompt injection. Bayan Flow sees the tool calls the app makes, not your conversation with it.

Never possible over MCP, whatever you allow

  • Deleting the workspace
  • Transferring ownership or changing the owner
  • Passwords, sessions, two-step verification and sign-in
  • Creating, listing or revoking API keys
  • Turning integrations on or off, or choosing who manages them
  • Plans, seats, payment methods, invoices and refunds
  • Exporting personal data
  • Anything at the level of the Bayan platform
  • Anything in another workspace

Read our Privacy Policy · Terms of Service

Troubleshooting

The Allow button is greyed out

Choose a workspace first. If you have more than one, none is chosen for you. A line above the button says what is missing.

No workspace is listed on the approval page

Only workspace owners, and admins the owner allowed to manage integrations, can connect an app. Ask the owner to connect it or to give you that permission.

The page says the integration is turned off

Bayan Flow switched MCP off for that workspace. Contact support from the contact page.

The app says the connection expired or needs signing in again

Connections renew themselves while they are used. After a year, or if the connection was revoked, press Connect again in the app.

Why did it ask for my password?

Anything beyond reading asks for your password, as creating an API key does. If you sign in only with Google, set a password first in Settings → Security.

A tool I expected is missing

The app sees only the tools your permissions allow. Connect again and tick more permissions.

The app reports too many requests

Each connection allows 120 tool calls and 30 writes a minute. Wait a moment and try again.

The workspace already has the maximum number of connections

A workspace can have five MCP connections at once. Revoke one you no longer use in Integrations → MCP.

Still stuck? Write to us from the contact page

Technical reference

For developers and for reviewers checking the connection.

Server address
https://bayanflow.tech/api/v1/mcp
Transport
Streamable HTTP, stateless: POST only, no sessions and no event stream.
MCP protocol versions
2025-11-25, 2025-06-18, 2025-03-26
Authorization
OAuth 2.0 authorization code with PKCE (S256), public clients, dynamic client registration (RFC 7591), discovery by RFC 9728 and RFC 8414.
Protected resource metadata
https://bayanflow.tech/.well-known/oauth-protected-resource/api/v1/mcp
Authorization server metadata
https://bayanflow.tech/.well-known/oauth-authorization-server
Authorization endpoint
https://bayanflow.tech/oauth/authorize
Token endpoint
https://bayanflow.tech/api/oauth/token
Client registration
https://bayanflow.tech/api/oauth/register
Revocation endpoint
https://bayanflow.tech/api/oauth/revoke
Tokens
Access token one hour. Refresh token rotates on every use: 60 days from the last use, one year at most. The previous refresh token is invalid.
Scopes
knowledge:read, knowledge:write, workspace:read, workspace:admin
Limits
Per connection: 120 tool calls and 30 writes a minute. One answer is cut at 100 KB.

Ready to connect?

Create a workspace or sign in, then follow the three steps above.

Create an accountSign in