MCP · API 接入文档

miwrite MCP 接入指南

miwrite MCP 已实现文档处理、知识检索与专业写作工具。本地 stdio 可用于开发,公开目录可直接查看;Hosted MCP 的远程执行能力由生产开关控制。

服务端: miwrite-mcp 阶段: beta 协议: JSON-RPC 2.0 Schema: v1
当前生产状态 生产环境设置 MARGIN_REMOTE_MCP_ENABLED=false。静态文档、公开发现/目录和本地 stdio 可用;远程 API key、OAuth、RPC 与工具调用当前关闭。下面的远程示例仅说明已实现的接入契约,现在不能用于连接生产服务。

1概述

公开目录记录了 8 个付费 pipeline 和 8 个免费 helper 的实现契约。远程开关启用后,客户端可先用 list_model_profiles 查看可用模型,再调用 pipeline;当前生产只能查看目录,不能远程调用。付费 pipeline 可传 module_ids;未传时服务端自动选择至多 6 个知识模块。

属性
服务端 IDmiwrite-mcp
阶段phase2-remote-rpc-beta
远程传输已实现;当前生产关闭(MARGIN_REMOTE_MCP_ENABLED=false
本地传输stdio(可用,npm run mcp:dev
认证远程启用后使用 Bearer API key;当前 key/OAuth 路由关闭
输入模式text-first
输出契约结构化 JSON,主输出字段为 report_markdown
Pipeline 工具8
Helper 工具8

2远程接入参考

以下步骤说明远程能力启用后的接入契约。当前生产远程开关关闭,不能获取 API key 或调用这些端点。现在可使用 npm run mcp:dev 启动本地 stdio,查看公开目录,或安装下文的 Local Skills。

第一步:获取 API Key(当前不可用)

远程能力启用后,可在 MCP 控制台 登录并创建 key。默认 key 包含 catalog.readtools.listtools.callpipelinesmcp.readstatus.read。包括免费 helper 工具在内,所有 Hosted MCP 远程接口都需要 API key;纯本地 Skills 不需要登录。当前生产的 key 创建、列出和撤销路由均已关闭。

第二步:列出工具

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 和 8 个免费 helper。当前生产会拒绝该远程请求。

第三步:调用工具

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;当前生产请改用本地 stdio 或 Local Skills。

3接口列表

以下路径相对 https://miwrite.art。发现、状态与目录 GET 接口公开可读;标为“生产关闭”的路径只表示代码契约存在,当前不会提供远程服务。

路径 方法 认证 说明
/api/mcpGET公开发现文档
/api/mcp/statusGET公开服务状态与运行时信息
/api/mcp/catalogGET公开完整目录、契约和客户端分类
/api/mcp/remote/rpcPOSTBearer(生产关闭)启用后提供 JSON-RPC 2.0,支持 tools/listtools/callinitializeping
/api/mcp/remote/toolsGETBearer(生产关闭)启用后的 REST 风格工具列表
/api/mcp/remote/tools/listGETBearer(生产关闭)启用后的 REST 风格工具列表别名
/api/mcp/remote/tools/callPOSTBearer(生产关闭)启用后的 REST 风格工具调用
/api/mcp/remote/tools/call/streamPOSTBearer(生产关闭)启用后的 SSE 流式工具调用
/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 或 Hosted helper。

Pipeline 工具

正在加载工具定义...

Helper 工具

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

5知识库

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

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

当前包含什么

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

当前状态

  • 目前已经整理出 49 份可复用内容,后续会继续补。
  • 这些内容会随着任务需要持续扩充,不是一版写完就封存。
  • 知识库的目标不是替你提供材料证据,而是帮助你更稳地读材料、做判断、组织输出。
一句话理解 你可以把它看成持续更新的文档与知识工作方法库,而不是一批静态提示词。

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 工具

  • list_model_profiles:免费返回当前模型档位、启用状态和服务端默认值
  • get_workflow_pack:免费,返回本地执行所需的 prompt / steps / schema,不触发托管付费模型
  • search_kb:免费 hosted 知识检索;默认 hybrid_chunk,可 mode=keyword;单独日限额
  • search_kb 结果带回 chunk 元数据:chunk_idsource_pathheadingstart_lineend_line
  • get_template / get_term_map:免费取模板骨架与术语表
  • verify_claims:免费本地主张 vs 原文审计(非开放网页查证)
  • extract_citations / verify_citations:免费引用抽取与存在性核验

托管模型能力

  • 8 个 pipeline 工具通过托管模型运行,按量计费
  • 可选 module_ids 指定知识模块;未传时自动选择 ≤6 个 defaults
  • 余额接口和估价接口只用于托管模型模式

模型选择

所有付费 pipeline 都接受可选 model_profile。省略时使用 list_model_profiles 返回的 default_model_profile;调用前应以该工具返回的 enabled 状态为准。

档位适用场景
deepseek_v4_flash快速整理、提取与日常改写;当前服务端默认
deepseek_v4_pro长材料、复杂结构与均衡质量
gemini_3_1_pro 系列按次调用;包含标准、Thinking 与 High 档位
grok_4_5_relayGrok 4.5 中转;适合复杂改写、综合分析与长文稿任务
claude_sonnet_4_6高质量写作与综合任务
claude_opus_4_7 / claude_opus_4_6_t 系列高要求评审、推理与深度任务

远程启用后的默认限额

能力 默认 user 级日限额 说明
search_kb200 / day仅该工具;不同 key 共享同一 user 级计数
其他免费 helper + 托管 tools/call100 / day共用 tools_call 桶;不同 key 共享同一 user 级计数
启用后的 key 语义 远程开关启用后,key 独立的是权限,不是独立余额;默认仍共享同一用户账户余额与免费额度。当前生产不提供 key 路由。
纯本地 Skills 纯本地 Skills 不经过这些 API,不需要登录,也不需要 MIWRITE_API_KEY。它们只读取本地文件、本地笔记和项目上下文。

9客户端接入

这里描述的是 Hosted MCP 已实现的客户端契约。代码层面,对外最值得强调的一点是:Zotero 已经可以直接连进来,文献收藏夹、最近文献和单条条目都能读;但当前生产远程开关关闭,外部客户端暂时不能连接。现在请使用本地 Skills 或本地 stdio。

哪些软件可以接,怎么接

软件 推荐方式 服务提供方式
Zotero(文献库)文献库直连(生产远程关闭)契约已实现;待远程开关启用后,可读取收藏夹、最近文献和单条条目。
Claude Desktop远程 Hosted MCP(生产关闭)契约已实现,当前不能直连 https://miwrite.art/mcp
Cursor远程 Hosted MCP(生产关闭)契约已实现,当前不要在 .cursor/mcp.json 中配置生产远程地址。
Claude Code本地 Skills + 可选远程 Hosted MCP当前使用本地 Skills;远程服务需等待生产开关启用。
OpenAI / Codex 类运行时远程 Hosted MCP(生产关闭)远程契约已实现,但当前生产不接受连接。
OpenCode本地 stdio / 远程可选当前使用本地 stdio;远程方式需等待生产开关启用。
文献软件支持 从实现成熟度看,Zotero 也是当前最成熟、最适合主推的一条文献软件接入路径;这里的“主推”指后续开放顺序,不代表今天可以连接。生产远程服务目前关闭,现在可先把题录、摘要或笔记导出后交给 miwrite 处理。
正在加载客户端分类...

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"
      }
    }
  }
}
当前不能连接 以上配置只保留为已实现契约的参考。当前生产设置 MARGIN_REMOTE_MCP_ENABLED=false,不能创建实际 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 (Production Disabled)
claude mcp add-json miwrite '{"type":"url","url":"https://miwrite.art/mcp","headers":{"Authorization":"Bearer mcp_YOUR_API_KEY"}}'
Boundary 前两个安装命令只安装本地 Skills,当前可用。第三个命令仅为远程能力重新启用后的配置参考;当前生产 Hosted MCP 远程网关关闭,不能连接。

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更新日志

完整条目见仓库 CHANGELOG.md。以下记录代码契约的演进,不代表当前生产已启用远程服务;部署可用性以页首状态为准。

2026-08-04

  • 新增免费 list_model_profiles,Hosted MCP 客户端可在付费调用前发现默认模型与当前启用状态。
  • 8 个 pipeline 的 model_profiletools/list 中提供明确枚举。
  • 产品品牌统一为 miwrite,定位扩展为通用文档与知识工作台;学术能力保留为专业 Skills 和模块。

2026-07-12

  • Hosted MCP 正式可调用免费 helper:从 2 个扩到 7 个(含 get_templateget_term_mapverify_claimsextract_citationsverify_citations)。
  • search_kb 默认 hybrid(关键词 + 本地 TF-IDF);chunk 元数据保持返回。
  • 付费 pipeline 支持可选 module_ids;未传时自动选择 ≤6 个知识模块。
  • verify_claims 仅做本地主张 vs 原文审计,不承诺开放网页事实核查。
  • 限额:仅 search_kb 使用独立日限额;其余免费 helper 与托管 tools/call 共用日限额桶。
  • 本地 Skills 补充 Minimum inputs / Output skeleton,并与 Hosted MCP 继续解耦。

更早

  • Hosted MCP 公开 8 个 pipeline 工具。
  • search_kb / get_workflow_pack 升级为正式可调用 free tool。
  • 公开文档明确 bundle registry、search_kb 与 MCP resources 的统一边界。
  • expert_paid 已从公开 model profile 列表移除,但旧输入兼容保留。

需要接入支持?

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