Docs

几分钟接入你的 Codex

从 CLI 安装到 MCP 配置,四步完成。下面是最快路径,详细 API 文档后续补充。

Quick start

四步走

1

安装 CLI

通过 npm / pnpm / bun 全局安装 Grain CLI。

cli
2

登录授权

浏览器打开授权页,授权 Codex 读取 membership。

auth
3

项目初始化

扫描 tokens / 组件命名约定,建立项目上下文。

init
4

接入 MCP

把 Grain MCP server 加入 Codex 配置即可。

mcp

安装与初始化

@grain/cli 装到全局。然后用 grain login 完成浏览器授权——这一步会建立一个本地 session token,有效期 30 天,可以在设置页随时吊销。

terminal
bash
# 安装 CLI
pnpm add -g @grain/cli

# 登录并连接 Codex
grain login

# 在项目目录初始化
cd your-project
grain init

初始化阶段,Grain 会扫描当前项目的 design tokens、组件命名约定和已有样式系统,把这份"项目上下文"作为后续检索的 baseline。这一步不会修改任何文件,只读。

MCP 接入

把 Grain 作为 MCP server 注入 Codex 配置。Codex 启动时会自动连接,evidence pack 通过 mcp/grain/evidence 工具按需检索。

codex.config.json
json
{
  "mcpServers": {
    "grain": {
      "command": "grain",
      "args": ["mcp", "serve"]
    }
  }
}

支持的参数

  • category:页面类型,如 pricing / settings / dashboard
  • tone:产品语气,如 quiet / dense / playful
  • constraints:约束列表,如 "no JS framework" / "max-w-6xl"