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

Discovery-First Workflow

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

Discovery-First Workflow

md2wechat 这套东西最怕一件事:还没确认当前能力,就先开始写规则、选主题、选 provider、选模块。

更稳的做法是反过来。

先发现,再决定,再执行。

第一步:先看当前到底开放了什么

先跑:

md2wechat doctor --json
md2wechat capabilities --json

这一步先确认:

  • 当前本机配置是否具备尝试 API 相关任务的条件
  • 默认模式是什么
  • 有哪些高层能力
  • 现在这台机器能不能走完整链路

第二步:再看可用资源

根据你的任务,再继续看:

md2wechat providers list --json
md2wechat themes list --json
md2wechat prompts list --json
md2wechat layout list --json

这一步的作用很简单:

  • 不靠猜 provider
  • 不靠猜 theme
  • 不靠猜 prompt
  • 不靠猜模块目录

第三步:只看当前要用的那个对象

如果你已经知道大方向,再继续看具体对象:

md2wechat providers show volcengine --json
md2wechat layout show hero --json
md2wechat prompts show cover-hero --kind image --json

这时候你才去确认字段、模型、示例和限制。

如果检查的是排版模块,注意返回结果里的 body_format。它会告诉你这个模块需要 fields、rows、json_object 还是 json_array。

第四步:最后才执行真正任务

走到这里,再去做:

  • convert
  • preview
  • generate_image
  • article-draft

这条顺序会少很多无效报错。

处理文章时,真正执行前先检查这篇文件:

md2wechat inspect article.md --json

如果要创建草稿,用同样的封面参数检查草稿目标:

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

为什么这对 Agent 特别重要

对人来说,猜错一次,最多重来。

对 Agent 来说,如果一开始就建立在错误假设上,后面整条链都会偏:

  • 选错 theme
  • 写错模块
  • 用了不存在的模型
  • 把 AI 模式当成最终输出

一个最小工作流

第一次接入时,推荐这个顺序:

md2wechat doctor --json
md2wechat capabilities --json
md2wechat layout list --json
md2wechat layout show hero --json
md2wechat inspect article.md --json
md2wechat preview article.md

适合什么时候强制这么做

下面这些情况,最好坚持 discovery-first:

  • 第一次接新环境
  • 刚切换 provider
  • 刚升级版本
  • 要把规则交给 Agent 长期复用

继续看

  • Mode Selection
  • doctor 与 inspect 准备状态
  • Advanced Layout Mistakes
  • Setup and Troubleshooting

Advanced Layout Mistakes

第一次接高级排版,真正常见的不是“不会写”,而是把结构和场景搞混。

doctor 与 inspect 准备状态

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

目录

Discovery-First Workflow
第一步:先看当前到底开放了什么
第二步:再看可用资源
第三步:只看当前要用的那个对象
第四步:最后才执行真正任务
为什么这对 Agent 特别重要
一个最小工作流
适合什么时候强制这么做
继续看