Design Brief Generator Provider

一个独立的、本地优先的 TypeScript provider，可根据网站 URL 和/或品牌详情生成结构化的设计简报。输出是确定性的，支持英语（en）和西班牙语（es）两种语言，并通过直接函数和 MCP 形状的 JSON-RPC 2.0 处理器两种方式暴露。

这是一个独立的 provider。它不连接或修改 Stellar Bazaar，也不需要密钥、支付凭据或钱包。

要求

• Node.js 22.6 或更高版本（推荐 Node 24）

• 无运行时依赖

Related MCP server: @forgespace/branding-mcp

快速开始

npm test
npm run build
npm run audit:files
npm run example

在禁用脚本执行的 Windows PowerShell 上，使用 npm.cmd test。编译输出写入被忽略的 dist/，并且永远不会提交或上传到 Vercel。

import { generateDesignBrief } from "./src/index.ts";

const result = generateDesignBrief({
  url: "https://example.com",
  locale: "es",
  brand: {
    name: "Marca Ejemplo",
    industry: "tecnología",
    audience: ["Equipos de producto"],
    values: ["Claridad", "Confianza"],
    colors: ["#101828", "#7F56D9"]
  }
});

url 或 brand.name 至少需要提供一个。当品牌名称缺失时，URL 会提供一个人性化的主机名。provider 不会获取 URL，它仅将其作为本地输入，这使 fixture 行为安全且可复现。

契约

generateDesignBrief(input) 返回 ProviderResult<DesignBrief>：要么是 { ok: true, data }，要么是 { ok: false, error }。设计简报包括项目目标和约束、品牌策略和视觉方向、体验原则、页面建议、交付物、指标和明确的假设。

MCP 形状的处理器支持：

• initialize

• tools/list

• tools/call 以及 generate_design_brief

import { handleMcpRequest } from "./src/index.ts";

const response = handleMcpRequest({
  jsonrpc: "2.0",
  id: 1,
  method: "tools/call",
  params: {
    name: "generate_design_brief",
    arguments: { url: "https://example.com", locale: "en" }
  }
});

这是一个进程内协议适配器，而不是网络服务器。宿主可以将其映射到 stdio 或 HTTP，而无需更改生成契约。Provider 元数据也可以在 service-card.json 中以及作为导出的 serviceCard 常量获得。

HTTP API

Vercel 部署暴露了相同的本地契约：

生产环境： https://design-brief-provider.vercel.app

• GET / — 服务发现和 Tool schema

• GET /health — 健康和版本响应

• POST /api — 直接 GenerateBriefInput，返回 ProviderResult<DesignBrief>

• POST /api — 用于 MCP 形状适配器的 JSON-RPC 2.0 请求

curl -X POST https://design-brief-provider.vercel.app/api \
  -H "content-type: application/json" \
  -d '{"url":"https://example.com","locale":"es"}'

URL 仅被视为元数据；provider 不执行任何出站网站抓取。

部署到 Vercel

将此仓库作为新的 Vercel 项目导入，并使用默认框架预设。不需要环境变量、数据库、构建输出、支付或钱包配置。api/ 处理器和 vercel.json 重写已准备好部署。

开发

npm test
npm run build
npm run audit:files
npm run example

测试套件覆盖确定性 URL 输入、西班牙语品牌输入、验证失败、发现和 MCP 形状的调用。 已提交的 fixtures/stellar-brief.es.json 文件是一个稳定的、本地的示例输出，并由测试套件检查。

许可证

Apache License 2.0。参见 LICENSE。