md2wechat Agent API markAgent API 文档
md2wechat Agent API markAgent API 文档
首页

开始

Markdown 转微信公众号 API 文档QuickstartAuth

接口

API OverviewThemeConvert发布 API微信 IP 白名单多账号发布图片生成标题生成封面图Advanced LayoutMode SelectionAdvanced Layout Use CasesAdvanced Layout SyntaxAdvanced Layout MistakesDiscovery-First Workflowdoctor 与 inspect 准备状态Advanced Layout Recipes排版模块目录

接入

运维

ErrorsPricingContact
X (Twitter)
API

doctor 与 inspect 准备状态

使用 doctor 和 inspect 的准备状态输出,在预览、转换、上传或创建草稿前判断当前任务是否可以继续。

doctor 与 inspect 准备状态

md2wechat 2.4.0 给 Agent 提供了更清楚的判断方式:在转换、上传、创建公众号草稿之前,先判断当前任务到底能不能做。

最短规则是:

先用 doctor --json 检查本机配置,再用 inspect --json 检查单篇文章。

两个命令分别回答什么

命令用来判断不要把它当成
md2wechat doctor --json本机配置是否具备尝试条件某篇文章一定可以发布
md2wechat inspect article.md --json单篇文章的目标状态账号登录或真实上传测试

doctor 是本地检查。它判断当前机器是否具备尝试转换、生图、创建草稿的基本配置。

inspect 检查某一篇 Markdown,并告诉你预览、转换、上传、草稿这些目标分别是 ready、blocked、degraded 还是 not requested。

推荐顺序

新环境或升级后,先跑:

md2wechat version --json
md2wechat doctor --json
md2wechat capabilities --json

处理单篇文章时,再跑:

md2wechat inspect article.md --json
md2wechat preview article.md
md2wechat convert article.md

如果要创建公众号草稿,先检查草稿目标:

md2wechat inspect article.md --draft --cover cover.jpg --json
md2wechat convert article.md --draft --cover cover.jpg

新的准备状态结构

新的 Agent 应该优先读取 inspect --json 里的这些字段:

{
  "data": {
    "readiness": {
      "schema_version": "1",
      "targets": {
        "preview": "ready",
        "convert": "ready",
        "upload": "not_requested",
        "draft": "blocked"
      },
      "blockers": [
        {
          "code": "MISSING_COVER",
          "target": "draft"
        }
      ]
    }
  }
}

旧字段仍然保留:

  • convert_ready
  • upload_ready
  • draft_ready
  • preview_fidelity

但对 Agent 来说,targets 和 blockers 更适合作为判断依据,因为它们会说清楚哪个目标被什么问题挡住了。

常见阻塞项

阻塞项通常代表下一步检查
MISSING_API_KEYAPI 模式还不能运行检查 md2wechat doctor --json 和配置
LOCAL_IMAGE_MISSINGMarkdown 里引用了不存在的本地图片修正图片路径或删除引用
MISSING_COVER创建草稿缺少封面传入 --cover 或 --cover-media-id

Agent 应该怎么做

做自动化流程时,建议固定成这个顺序:

  1. API 相关任务前先跑 doctor --json。
  2. 只跑当前任务需要的发现命令。
  3. 对单篇文章跑 inspect --json。
  4. 如果目标被阻塞,停止该目标并说明阻塞原因。
  5. 用户还没看过结果时,先预览,再转换或创建草稿。

这样可以减少猜测,也更容易把失败原因讲清楚。

继续阅读

  • 发现优先工作流
  • 模式选择

Discovery-First Workflow

先看当前能力,再决定怎么转、怎么选模块、怎么出图、怎么发草稿,这样最稳。

Advanced Layout Recipes

先看内容要完成什么,再选少量合适的模块。适合 Agent 和 API 接入方直接参考。

目录

doctor 与 inspect 准备状态
两个命令分别回答什么
推荐顺序
新的准备状态结构
常见阻塞项
Agent 应该怎么做
继续阅读