Skip to content

docs: add Connect-It connectors documentation - #5

Open
wishworldbetter wants to merge 1 commit into
memohai:mainfrom
wishworldbetter:docs/connect-it
Open

docs: add Connect-It connectors documentation#5
wishworldbetter wants to merge 1 commit into
memohai:mainfrom
wishworldbetter:docs/connect-it

Conversation

@wishworldbetter

Copy link
Copy Markdown
Contributor

这个 PR 做什么

给连接器功能(Memoh #915 / #911 / #923)补文档。这块目前全站零覆盖。

改动

新页面 guides/connectors.md(中英)

  • 连接器是什么:凭据存 Connect-It,Memoh 只存绑定表
  • 前提:[connect_it] 配置段;没配置时超市不显示 Connectors tab
  • 连接流程:超市 → Connect → 选 Bot → OAuth 或 API Key
  • 管理:六种连接状态的含义,启停 / 重新授权 / 断开(断开会连 Connect-It 里的凭据一起删);OAuth 中途放弃会留一条挂起记录、要手动断开,这个也写了
  • 工具怎么到 Bot 手上:聚合 MCP 会话;命名空间按连接器类型生成(githubgithub-2),绑定后不变

Server Deploy(中英)

  • 服务表加 connect-it(profile connectors,共库但独立 connect_it schema)
  • 新小节:全新安装默认 embedded、升级保持关闭;四件凭据生成一次写 .env 升级复用;管理台在 8421;从其它机器访问要设 MEMOH_CONNECT_IT_PUBLIC_BASE_URL;Connect-It 镜像在 ghcr.io、memoh.cn 镜像源不覆盖
  • 手动部署:自己生成凭据 + --profile connectors 的完整命令
  • 配置总览、环境变量表、访问地址表同步补齐

顺带

  • 超市页:两 tab 改三 tab,Connectors 排第一、配置了 Connect-It 时是默认落地 tab
  • Bot 页:tab 表按 UI 实际顺序插入 Connectors 行
  • 两份 sidebar 加入口

核实

  • 内容对照 main 上的实际代码写的:install.sh 的模式语义和凭据生成、docker-compose.yml 的 connectors profile、Web UI 的 en 文案、internal/connectors 的 alias 分配逻辑
  • 一个和 #911 描述不一致的地方:PR 里写的独立 connect-it-web 容器和 8083 端口后来去掉了,现在只有单个 connect-it 服务、管理台和 API 同在 8421(install.sh 里 memoh-connect-it-web 已进 legacy 清理列表),文档按现状写
  • pnpm build 通过;中英文锚点(含 #connect-it-连接器)在构建产物里核对过

New Connectors guide (en/zh): connecting third-party services from the
Supermarket, connection statuses and management on the bot detail page,
and how connector tools reach the agent through the aggregated MCP
session with per-binding tool namespaces.

Server Deploy: document the co-hosted Connect-It service — install
script provisioning (embedded by default on fresh installs, disabled
kept on upgrades), generated credentials persisted in .env, admin
console on 8421, OAuth callback public base URL, ghcr.io mirror caveat,
manual compose setup, and the [connect_it] config section.

Supermarket and Bot pages updated for the new Connectors tab.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant