MCP · API 接入文档

咪咪 MCP 接入指南

这份文档说明咪咪 MCP 的公开契约。当前产品分成两条路径:本地 Skills 是纯本地模式;Hosted MCP 则提供免费 helper 工具和在线付费模型能力。两者是分离的合同,不共享安装方式。

服务端: miwrite-mcp 阶段: beta 协议: JSON-RPC 2.0 Schema: v1

1概述

咪咪 MCP 当前暴露 8 个学术 pipeline 工具,以及 2 个正式可调用的免费 helper 工具:search_kbget_workflow_pack。前者是 hosted knowledge search,后者用于获取本地执行所需的工作流包。

属性
服务端 IDmiwrite-mcp
阶段phase2-remote-rpc-beta
远程传输JSON-RPC 2.0 over HTTPS POST
本地传输stdio(开发环境,npm run mcp:dev
认证Bearer API key
输入模式text-first
输出契约结构化 JSON,主输出字段为 report_markdown
Pipeline 工具8
Helper 工具7

2快速开始

最短路径是:获取 API key → 列出工具 → 调用工具。若你只想做本地工作流执行,优先使用 get_workflow_pack。若你要零登录纯本地模式,请直接安装下文的 Local Skills。

第一步:获取 API Key

MCP 控制台 登录后创建 key。默认 key 包含 catalog.readtools.listtools.callpipelinesmcp.readstatus.read。包括免费 helper 工具在内,所有 Hosted MCP 远程接口都需要 API key;纯本地 Skills 不需要登录。

第二步:列出工具

curl
curl -s -X POST https://miwrite.art/api/mcp/remote/rpc \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "tools/list",
    "params": {}
  }'
响应 返回 {"jsonrpc":"2.0","id":1,"result":{"tools":[...]}}。当前应能看到 8 个 pipeline 工具,以及 2 个免费工具:search_kbget_workflow_pack

第三步:调用工具

curl
curl -s -X POST https://miwrite.art/api/mcp/remote/rpc \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 2,
    "method": "tools/call",
    "params": {
      "name": "run_lit_review_pipeline",
      "arguments": {
        "input_text": "Your literature text here...",
        "topic": "Research topic"
      }
    }
  }'
本地工作流执行 如果你不想调用托管付费模型,优先使用 get_workflow_pack 获取本地执行所需的 prompt、steps 和 schema,再由本地模型完成执行。这个 helper 依然通过 Hosted MCP 网关返回,因此仍需要 API key。

3接口列表

以下路径相对 https://miwrite.art。无认证接口标记为公开。

路径 方法 认证 说明
/api/mcpGET公开发现文档
/api/mcp/statusGET公开服务状态与运行时信息
/api/mcp/catalogGET公开完整目录、契约和客户端分类
/api/mcp/remote/rpcPOSTBearerJSON-RPC 2.0 端点,支持 tools/listtools/callinitializeping
/api/mcp/remote/toolsGETBearerREST 风格工具列表
/api/mcp/remote/tools/listGETBearerREST 风格工具列表别名
/api/mcp/remote/tools/callPOSTBearerREST 风格工具调用
/api/mcp/remote/tools/call/streamPOSTBearerSSE 流式工具调用
/api/mcp/remote/statusGETBearer认证状态
/api/mcp/remote/catalogGETBearer认证目录
/api/mcp/remote/balanceGETBearer账户余额与免费额度
/api/mcp/remote/estimatePOSTBearer托管模型调用前估价
/api/mcp/remote/workflow-packPOSTBearer兼容保留:返回指定工具的 workflow pack
/api/mcp/remote/search-kbPOSTBearer兼容保留:知识库检索
/api/mcp/remote/kb-modulesGETBearer兼容保留:知识库模块列表
/api/mcp/keysGETSession列出当前用户 API key
/api/mcp/keysPOSTSession创建新 API key
/api/mcp/keys/:id/revokePOSTSession撤销指定 key

4工具参考

以下定义实时读取自 /api/mcp/catalog,避免文档与实现漂移。Pipeline 是托管模型工作流;helper 则包含免费 helper 工具和 catalog-only 目录项。

Pipeline 工具

正在加载工具定义...

Helper 工具

正在加载辅助工具定义...

5知识库

咪咪的知识库是一套不断补充的研究内容集合。它不是一个下载区,而是把常用的方法、判断标准、术语说明和例子整理成稳定的内容底座,方便在不同任务里重复使用。

构成 主要内容 你会怎么用到
研究方法如何做文献综述、如何整理材料、如何精读文本、如何评阅稿件、如何把结果写成报告需要搭工作流、定分析路径、判断下一步时
判断标准不同任务的质量标准、常见失误、证据强弱和修改优先级想知道输出够不够稳、哪里还差时
术语与例子常用术语说明、写法对照、精选例子、负面反例写作、润色、转写、解释概念时

当前包含什么

  • 研究方法:材料整理、资料分析、文献综述、文本精读、稿件评阅、报告模式、研究设计压力测试。
  • 质量标准:不同任务的 rubric、证据判断、问题分级和修改优先级。
  • 辅助内容:术语说明、写作风格、精选例子、常见反例。

当前状态

  • 目前已经整理出 37 份可复用内容,后续会继续补。
  • 这些内容会随着任务需要持续扩充,不是一版写完就封存。
  • 知识库的目标不是替你提供材料证据,而是帮助你更稳地读材料、做判断、组织输出。
一句话理解 你可以把它看成一位一直在补课、一直在整理方法和例子的研究助理,而不是一个静态资料库。

6示例输出

托管 pipeline 和免费 helper 工具使用不同的成功载荷,但都遵循统一的 `ok/error_code/message` 约束。

Hosted Pipeline Result
{
  "ok": true,
  "tool": "run_lit_review_pipeline",
  "request_id": "mcp_req_xxx",
  "workflow": "literature",
  "report_markdown": "## 文献综述...",
  "usage": { "totals": { "tokens_in": 1200, "tokens_out": 800 } }
}
Free Hosted Helper Result
{
  "ok": true,
  "tool": "get_workflow_pack",
  "target_tool": "run_lit_review_pipeline",
  "pack": {
    "steps": ["parse", "final"],
    "input_schema": { "...": "..." }
  }
}

7错误规范

MCP 公共契约将错误收敛到少量稳定代码,便于客户端直接处理。

状态/代码 说明
401缺少或无效 Bearer key
403key 有效,但 scope 不足
400 + needs_input缺少必填参数
400 + invalid_argument参数枚举或格式不合法
402 + insufficient_balance托管模型调用余额不足
429 + rate_limit_exceededuser 级日限额命中
500 + internal_error服务端运行时异常

8计费与限额

当前产品在 Hosted MCP 网关内分成两类能力:免费 helper 工具和托管模型能力。纯本地 Skills 不经过这些 API。

免费 Helper 工具

  • get_workflow_pack:免费,用于本地工作流执行,不触发托管付费模型
  • search_kb:免费,但属于 hosted knowledge search,并有 user 级日限额

托管模型能力

  • 8 个 pipeline 工具通过托管模型运行,按量计费
  • 余额接口和估价接口只用于托管模型模式

当前默认限额

能力 默认 user 级日限额 说明
search_kb200 / day不同 key 共享同一 user 级计数
tools/call(托管模型)100 / day不同 key 共享同一 user 级计数
当前 key 语义 key 目前独立的是权限,不是独立余额;默认仍共享同一用户账户余额与免费额度。
纯本地 Skills 纯本地 Skills 不经过这些 API,不需要登录,也不需要 MIWRITE_API_KEY。它们只读取本地文件、本地笔记和项目上下文。

9客户端接入

当前这里描述的是 Hosted MCP 网关接入。对外最值得强调的一点是:Zotero 已经可以直接连进来,文献收藏夹、最近文献和单条条目都能读。写作环境这边,再根据不同软件选择远程 Hosted MCP、本地 Skills 或本地 stdio 的方式。

哪些软件可以接,怎么接

软件 推荐方式 服务提供方式
Zotero(文献库)文献库直连连接 Zotero 后,可以直接读取收藏夹、最近文献和单条条目,适合把自己的文献库直接带进研究流程。
Claude Desktop远程 Hosted MCP直接连 https://miwrite.art/mcp,适合把咪咪当成一个在线研究工作台来用。
Cursor远程 Hosted MCP.cursor/mcp.json 里填远程地址,适合边写边调研究工作流。
Claude Code本地 Skills + 可选远程 Hosted MCP默认先装本地 Skills;如果你还想用账号、余额和 Hosted 能力,再额外加远程服务。
OpenAI / Codex 类运行时远程 Hosted MCP按宿主支持情况连接远程 MCP,更适合把咪咪当成远程工具服务接进去。
OpenCode本地 stdio / 远程可选开发时更适合本地跑;需要统一鉴权和 Hosted 能力时再换远程方式。
文献软件支持 现在直连支持的是 Zotero。这也是当前最成熟、最适合主推的一条文献软件接入路径。如果你用的是其他文献软件,也可以先把题录、摘要或笔记导出来,再交给咪咪继续处理。
正在加载客户端分类...

Claude Desktop

编辑 claude_desktop_config.json(菜单 → Settings → Developer → Edit Config),加入以下配置:

claude_desktop_config.json
{
  "mcpServers": {
    "miwrite": {
      "type": "url",
      "url": "https://miwrite.art/mcp",
      "headers": {
        "Authorization": "Bearer mcp_YOUR_API_KEY"
      }
    }
  }
}

Cursor

在项目根目录创建 .cursor/mcp.json,或在全局 ~/.cursor/mcp.json 中加入以下配置:

.cursor/mcp.json
{
  "mcpServers": {
    "miwrite": {
      "url": "https://miwrite.art/mcp",
      "headers": {
        "Authorization": "Bearer mcp_YOUR_API_KEY"
      }
    }
  }
}
说明 以上配置使用远程 URL 模式("type": "url"),适用于 Claude Desktop 最新版和 Cursor。请将 mcp_YOUR_API_KEY 替换为在 MCP 控制台 创建的实际 API key。端点为 https://miwrite.art/mcp,客户端会自动完成协议协商。

10Skill System

miwrite provides 9 local skills for Claude Code, Codex, Cursor, and similar local agents. These skills are separate from the hosted MCP service: they do not require login, do not require MIWRITE_API_KEY, and do not use the hosted knowledge base.

Run From Your Target Project 在你想安装 Skills 的项目目录里执行下面命令。脚本会自动拉取或复用 miwrite.skill 仓库,然后把技能链接到当前项目。

Install

Bash
curl -fsSL https://raw.githubusercontent.com/lcrxgzl-wq/miwrite.skill/main/install-claude.sh | bash
Bash
curl -fsSL https://raw.githubusercontent.com/lcrxgzl-wq/miwrite.skill/main/install-codex.sh | bash
Hosted MCP Is Separate
claude mcp add-json miwrite '{"type":"url","url":"https://miwrite.art/mcp","headers":{"Authorization":"Bearer mcp_YOUR_API_KEY"}}'
Boundary 前两个安装命令只安装本地 Skills。第三个命令是单独配置 Hosted MCP 网关,可选,且与本地 Skills 不共享登录/API key 依赖。

Local Skill List

Command Skill Description
/miwrite-dataData AnalysisLocal qualitative coding and analysis
/miwrite-litLiterature ReviewLocal structured synthesis from user-provided literature
/miwrite-readClose ReadingLocal deep reading of a paper, report, or chapter
/miwrite-organizeOrganizeLocal material ledger and main-thread extraction
/miwrite-reviewReviewLocal manuscript or report critique
/miwrite-polishPolishLocal academic polishing or transcreation
/miwrite-askSocraticLocal guided research dialogue
/miwrite-design-stressDesign Stress TestLocal red-team review of a proposal or research design
/miwrite-report-modeReport ModeLocal brief, memo, and decision-facing report drafting
No Hosted Dependency Local skills do not use MIWRITE_API_KEY, do not call hosted MCP, and do not use hosted knowledge retrieval.

11更新日志

  • 当前 Hosted MCP 公开 8 个 pipeline 工具。
  • search_kb 已升级为正式可调用 free tool。
  • get_workflow_pack 已升级为正式可调用 free tool,用于本地工作流执行。
  • 公开文档新增知识库介绍,明确 bundle registry、search_kb 与 MCP resources 的统一边界。
  • 本地 Skills 已与 Hosted MCP 解耦。
  • expert_paid 已从公开 model profile 列表移除,但旧输入兼容保留。

需要接入支持?

如需特定宿主的接入指引或企业级支持,请联系我们。