monid

环境要求

• Deno 2.x 运行环境
• Git，用于克隆仓库
• 需要厂商 API Key 才能调用真实端点（可选）
• 无需 Node.js 或 npm

安装与启动步骤

1. 1安装 Deno 2.x

   Monid 只依赖 Deno 2.x，不依赖 Node/npm。请先到 deno.com 按官方说明装好并确认版本可用。

2. 2克隆仓库

   把 connector 层源码拉取到本地并进入项目目录，后续所有 deno task 命令都在此目录执行。

   git clone https://github.com/monid-ai/monid.git
   cd monid

   复制

3. 3类型检查与测试

   跑类型检查和 188 个回放测试，全程零网络访问，用于确认本地环境与仓库状态正常。

   deno task check && deno task test

   复制

4. 4配置厂商密钥

   调用真实端点需先设置环境变量，命名为 <PROVIDER>_CREDENTIALS_<FIELD>，例如 tinyfish 的搜索端点。

   export TINYFISH_CREDENTIALS_API_KEY=sk-xxxxxxxx

   复制

5. 5调用真实端点

   用 engine:run 执行指定端点，id 格式为 厂商#端点，查询参数用 JSON 字符串通过 --query-params 传入。

   export TINYFISH_CREDENTIALS_API_KEY=sk-xxxxxxxx
   deno task engine:run 'tinyfish#search' \
     --query-params '{"query":"solid-state battery suppliers","domain_type":"news"}'

   复制

6. 6浏览工具目录

   用 catalog 子命令查看已编译的 provider 与端点清单，inspect 可看单个端点的完整契约。

   deno task catalog providers
   deno task catalog endpoints --provider exa
   deno task catalog endpoints --category web-search
   deno task catalog inspect 'exa#search'

   复制

7. 7新增连接器（可选）

   仿照参考实现 connectors/exa 编写 provider 与 endpoint，用 record 录制 fixture 后提交 PR。

   deno task record

   复制

关键配置

如何确认成功

执行 deno task check && deno task test 全部通过（188 个回放测试、零网络）；或 deno task catalog providers 能列出 provider。

常见问题

注意事项

• 本项目是 connector 层，不是可直接对话的 Agent 应用，主要用于声明和编译工具端点
• 仓库自带的测试全部基于 fixture 回放，不会产生任何网络请求和费用
• 录制 fixture 后请保持精简（trimmed），避免提交冗余数据
• 提交连接器前必须保证 deno task check && deno task test 在无网络下通过