miwrite MCP 接入指南
miwrite MCP 提供文档处理、知识检索与专业写作工具。生产远程服务使用 API key,本地 stdio 继续用于开发。
1概述
公开目录记录了 8 个付费 pipeline 和 8 个免费 helper。客户端先用 list_model_profiles 查看可用模型,再调用 pipeline。付费 pipeline 可传 module_ids;未传时服务端自动选择至多 6 个知识模块。认证后的远程调用还可传 project_id,服务端会先校验项目归属,再加载受限的项目上下文。
| 属性 | 值 |
|---|---|
| 服务端 ID | miwrite-mcp |
| 阶段 | phase2-remote-rpc-beta |
| 远程传输 | Streamable HTTP(POST /mcp)与兼容 JSON-RPC |
| 本地传输 | stdio(可用,npm run mcp:dev) |
| 认证 | Bearer API key;不接受匿名工具调用 |
| 输入模式 | text-first |
| 输出契约 | 结构化 JSON,主输出字段为 report_markdown |
| Pipeline 工具 | 8 |
| Helper 工具 | 8 |
2远程接入参考
以下步骤用于接入生产远程服务。开发时仍可使用 npm run mcp:dev 启动本地 stdio,或安装下文的 Local Skills。
第一步:获取 API Key
在 MCP 控制台 登录并创建 key。默认 key 包含 catalog.read、tools.list、tools.call、pipelines、mcp.read、status.read。包括免费 helper 在内,所有 Hosted MCP 远程调用都需要 API key;纯本地 Skills 不需要登录。
第二步:列出工具
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 -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,但不扣付费模型余额。
pipelines 或 tools.call;知识资源与检索使用 kb.read;workflow pack、模板和提示词使用 templates.read;主张与引用核验使用 verify。默认 key 保留兼容所需的 tools.call 与 mcp.read,自定义 key 只获得明确授予的能力。
长任务:提交后轮询
付费 pipeline 可使用异步接口,避免客户端连接在长任务期间超时。提交时建议发送稳定且唯一的 Idempotency-Key;同一账号用同一 key 和相同参数重试会返回原任务,不会重复执行或扣费。相同 key 改传其他参数会返回 409 idempotency_conflict。
curl -s -X POST https://miwrite.art/api/mcp/remote/submit \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: lit-review-20260819-001" \
-d '{
"name": "run_lit_review_pipeline",
"arguments": {
"input_text": "Your literature text here...",
"topic": "Research topic"
}
}'
# HTTP 202
{
"ok": true,
"request_id": "mcp_req_...",
"task_id": "task_...",
"status": "pending",
"poll_url": "/api/mcp/remote/result/mcp_req_..."
}
curl -i -s \ -H "Authorization: Bearer <YOUR_API_KEY>" \ https://miwrite.art/api/mcp/remote/result/mcp_req_... # pending / running: HTTP 202 + Retry-After: 1 # completed / failed: HTTP 200
/remote/submit 上仍直接返回 HTTP 200。短任务也可继续使用同步的 /remote/tools/call;付费长任务建议使用 submit/result。任务状态在当前进程中保留 1 小时,且只允许创建任务的账号查询。服务重启会清空轮询状态;已发生的计费预留仍由结算与过期退款机制保护。
3接口列表
以下路径相对 https://miwrite.art。发现、状态与目录 GET 接口公开可读;key 管理使用登录会话,远程协议和工具调用使用 Bearer API key。
| 路径 | 方法 | 认证 | 说明 |
|---|---|---|---|
/api/mcp | GET | 公开 | 发现文档 |
/api/mcp/status | GET | 公开 | 服务状态与运行时信息 |
/api/mcp/catalog | GET | 公开 | 完整目录、契约和客户端分类 |
/mcp | POST | Bearer | Streamable HTTP,支持工具、资源、提示词与任务 |
/api/mcp/remote/rpc | POST | Bearer | 兼容 JSON-RPC 2.0,支持 tools/list、tools/call、initialize、ping |
/api/mcp/remote/tools | GET | Bearer | REST 风格工具列表 |
/api/mcp/remote/tools/list | GET | Bearer | REST 风格工具列表别名 |
/api/mcp/remote/tools/call | POST | Bearer | REST 风格工具调用 |
/api/mcp/remote/tools/call/stream | POST | Bearer | SSE 流式工具调用 |
/api/mcp/remote/submit | POST | Bearer | 提交付费长任务;支持 Idempotency-Key;免费 helper 同步返回 |
/api/mcp/remote/result/:request_id | GET | Bearer | 按创建账号轮询任务状态与结果 |
/api/mcp/remote/status | GET | Bearer | 认证状态 |
/api/mcp/remote/catalog | GET | Bearer | 认证目录 |
/api/mcp/remote/balance | GET | Bearer | 账户余额与免费额度 |
/api/mcp/remote/estimate | POST | Bearer | 托管模型调用前估价 |
/api/mcp/remote/workflow-pack | POST | Bearer | 兼容接口:返回指定工具的 workflow pack |
/api/mcp/remote/search-kb | POST | Bearer | 兼容接口:知识库检索 |
/api/mcp/remote/kb-modules | GET | Bearer | 兼容接口:知识库模块列表 |
/api/mcp/keys | GET | Session | 列出当前用户 API key,不返回完整密钥 |
/api/mcp/keys | POST | Session + 同源 | 创建 API key;完整密钥只返回一次 |
/api/mcp/keys/:id/revoke | POST | Session + 同源 | 撤销指定 key |
4工具参考
以下定义实时读取自公开的 /api/mcp/catalog,避免文档与实现漂移。目录公开可读;远程执行必须携带具备对应 scope 的 API key,并受余额、每日额度和速率限制约束。
Pipeline 工具
Helper 工具
5知识库
miwrite 的知识库是一套不断补充的专业内容集合。它不是一个下载区,而是把常用的方法、判断标准、术语说明和例子整理成稳定的内容底座,方便在不同任务里重复使用。
| 构成 | 主要内容 | 你会怎么用到 |
|---|---|---|
| 文档方法 | 如何整理材料、精读文本、评阅稿件、核对主张,以及把结果写成报告 | 需要搭工作流、确定处理路径、判断下一步时 |
| 判断标准 | 不同任务的质量标准、常见失误、证据强弱和修改优先级 | 想知道输出够不够稳、哪里还差时 |
| 术语与例子 | 常用术语说明、写法对照、精选例子、负面反例 | 写作、润色、转写、解释概念时 |
当前包含什么
- 通用方法:材料整理、文本精读、稿件评阅、报告模式、主张与引用核验。
- 专业模块:文献综述、质性资料分析、研究设计压力测试和学术转写。
- 质量标准:不同任务的 rubric、证据判断、问题分级和修改优先级。
- 辅助内容:术语说明、写作风格、精选例子、常见反例。
当前状态
- 目前已经整理出 49 份可复用内容,后续会继续补。
- 这些内容会随着任务需要持续扩充,不是一版写完就封存。
- 知识库的目标不是替你提供材料证据,而是帮助你更稳地读材料、做判断、组织输出。
6示例输出
托管 pipeline 和免费 helper 工具使用不同的成功载荷,但都遵循统一的 `ok/error_code/message` 约束。
{
"ok": true,
"tool": "run_lit_review_pipeline",
"request_id": "mcp_req_xxx",
"workflow": "literature",
"report_markdown": "## 文献综述...",
"material_passport": {
"access": "redacted",
"source_count": 2,
"citation_counts": { "verified": 4, "unverified": 1 }
},
"usage": { "totals": { "tokens_in": 1200, "tokens_out": 800 } }
}
{
"ok": true,
"tool": "get_workflow_pack",
"target_tool": "run_lit_review_pipeline",
"pack": {
"steps": ["parse", "final"],
"input_schema": { "...": "..." }
}
}
7错误规范
MCP 公共契约将错误收敛到少量稳定代码,便于客户端直接处理。
| 状态/代码 | 说明 |
|---|---|
401 | 缺少或无效 Bearer key |
403 | key 有效,但 scope 不足 |
400 + needs_input | 缺少必填参数 |
400 + invalid_argument | 参数枚举或格式不合法 |
402 + insufficient_balance | 托管模型调用余额不足 |
429 + rate_limit_exceeded | user 级日限额命中 |
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_id、source_path、heading、start_line、end_lineget_template/get_term_map:免费取模板骨架与术语表verify_claims:免费本地主张 vs 原文审计(非开放网页查证)extract_citations/verify_citations:免费引用抽取与存在性核验
托管模型能力
- 8 个 pipeline 工具通过托管模型运行,按量计费
- 可选
module_ids指定知识模块;未传时自动选择 ≤6 个 defaults - 远程调用可选
project_id;项目归属在限额、计费和模型执行前校验,返回结果不会包含项目上下文、Blob key、内部路径或文件字节 - 余额接口和估价接口只用于托管模型模式
模型选择
所有付费 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_relay | Grok 4.5 中转;适合复杂改写、综合分析与长文稿任务 |
claude_sonnet_4_6 | 高质量写作与综合任务 |
claude_opus_4_7 / claude_opus_4_6_t 系列 | 高要求评审、推理与深度任务 |
质量、风格与材料控制
run_review_pipeline和run_data_analysis_pipeline可显式传cross_model_profile。这会增加一次可计费模型调用;第二模型保留分歧,不取平均,也不覆盖首轮报告。- 付费 pipeline 可传
passport_access:redacted(默认)、raw或verified_only。返回的material_passport只含来源标签、计数、引用状态和质量摘要,不返回文稿全文、文件字节、Blob key 或内部路径。 run_polish_pipeline可传最多 12,000 字符的style_reference。它只用于提取语气、节奏和术语偏好,不复制参考文本的事实、论点、引用或专名。
默认限额
| 能力 | 默认 user 级日限额 | 说明 |
|---|---|---|
search_kb | 200 / day | 仅该工具;不同 key 共享同一 user 级计数 |
其他免费 helper + 托管 tools/call | 100 / day | 共用 tools_call 桶;不同 key 共享同一 user 级计数 |
MIWRITE_API_KEY。它们只读取本地文件、本地笔记和项目上下文。
9客户端接入
这里描述 Hosted MCP 的客户端契约。不同客户端支持的远程传输、资源和 OAuth 能力并不完全相同;接入时以客户端当前版本和实际握手结果为准。
哪些软件可以接,怎么接
| 软件 | 推荐方式 | 服务提供方式 |
|---|---|---|
| Zotero(文献库) | 账号连接 | 连接后可读取收藏夹、最近文献和单条条目;凭据只保存在服务端。 |
| Claude Desktop | 远程 Hosted MCP | 客户端版本支持远程 Streamable HTTP 时,连接 https://miwrite.art/mcp。 |
| Cursor | 远程 Hosted MCP | 在 MCP 配置中使用生产远程地址和 Bearer key。 |
| Claude Code | 本地 Skills + 远程 Hosted MCP | 可只安装本地 Skills,也可为支持远程 MCP 的环境配置 Hosted 服务。 |
| OpenAI / Codex 类运行时 | 远程 Hosted MCP | 宿主支持远程 MCP 时可接入;具体能力以宿主实现为准。 |
| OpenCode | 本地 stdio / 远程 Hosted MCP | 按使用环境选择本地 stdio 或远程服务。 |
Claude Desktop
客户端版本支持远程 MCP 时,编辑对应的 MCP 配置并加入以下地址。配置格式随客户端版本变化时,以客户端文档为准:
{
"mcpServers": {
"miwrite": {
"type": "url",
"url": "https://miwrite.art/mcp",
"headers": {
"Authorization": "Bearer mcp_YOUR_API_KEY"
}
}
}
}
Cursor
可在项目根目录创建 .cursor/mcp.json,或在全局 ~/.cursor/mcp.json 中加入以下配置:
{
"mcpServers": {
"miwrite": {
"url": "https://miwrite.art/mcp",
"headers": {
"Authorization": "Bearer mcp_YOUR_API_KEY"
}
}
}
}
timeout。长材料优先使用 POST /api/mcp/remote/submit,再轮询 /api/mcp/remote/result/:request_id;这样客户端连接无需保持到模型完成。
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.
miwrite.skill 仓库,然后把技能链接到当前项目。
Install
curl -fsSL https://raw.githubusercontent.com/lcrxgzl-wq/miwrite.skill/main/install-claude.sh | bash
curl -fsSL https://raw.githubusercontent.com/lcrxgzl-wq/miwrite.skill/main/install-codex.sh | bash
claude mcp add-json miwrite '{"type":"url","url":"https://miwrite.art/mcp","headers":{"Authorization":"Bearer mcp_YOUR_API_KEY"}}'
Local Skill List
| Command | Skill | Description |
|---|---|---|
/miwrite-data | Data Analysis | Local qualitative coding and analysis |
/miwrite-lit | Literature Review | Local structured synthesis from user-provided literature |
/miwrite-read | Close Reading | Local deep reading of a paper, report, or chapter |
/miwrite-organize | Organize | Local material ledger and main-thread extraction |
/miwrite-review | Review | Local manuscript or report critique |
/miwrite-polish | Polish | Local academic polishing or transcreation |
/miwrite-ask | Socratic | Local guided research dialogue |
/miwrite-design-stress | Design Stress Test | Local red-team review of a proposal or research design |
/miwrite-report-mode | Report Mode | Local brief, memo, and decision-facing report drafting |
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_profile在tools/list中提供明确枚举。 - 产品品牌统一为
miwrite,定位扩展为通用文档与知识工作台;学术能力保留为专业 Skills 和模块。
2026-07-12
- Hosted MCP 正式可调用免费 helper:从 2 个扩到 7 个(含
get_template、get_term_map、verify_claims、extract_citations、verify_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 列表移除,但旧输入兼容保留。