GitHubCard

com.githubcard由 githubcard.com 发布官方发布者v0.2.1更新于 Nov 1, 2026

Create GitHub profile and repository cards for READMEs, link previews and social posts.

已验证Streamable HTTP可网页运行开发者工具媒体与设计

概览

AI 生成的概览

GitHubCard 把 GitHub 用户或仓库变成可嵌入的卡片图片,返回 SVG/PNG 链接以及用于 README 和链接预览的 Markdown/HTML 片段。

可以做什么
  • 为 GitHub 用户或 owner/repo 创建(或复用)已发布的卡片,返回 SVG/PNG 链接和嵌入片段
  • 对卡片设计做试运行校验,检查模板、配色和 Pro 功能是否可用,且不消耗配额
  • 浏览模板、背景配色和组件类型,并把模板布局取回为可编辑的设计文档
  • 获取、列出并删除账户已有的卡片,查看套餐和当日剩余配额
  • 在本地服务器并开启文件写入参数时,把卡片插入或更新到磁盘上的 Markdown 文件
适用场景
适合需要为 README、链接预览或社交帖子制作 GitHub 个人主页或仓库卡片,或想通过助手而非网页编辑器自定义卡片布局(背景、尺寸、字体、组件)的场景。
运行要求
可作为托管的 Streamable HTTP 端点运行,也可通过 npx 以本地 npm 包运行(需 Node.js 20 或更高版本)。创建卡片需要 GitHubCard 控制台签发的免费 API 密钥,通过 GHCARD_API_KEY 环境变量或 Authorization Bearer 请求头传入。列出模板、配色和组件无需密钥。
安装前请注意
API 密钥属于机密,应放在环境变量或请求头中,不要写入共享配置。创建卡片会消耗每日配额(免费 100 张、Pro 5000 张,UTC 00:00 重置),免费卡片带水印。delete_card 会永久删除卡片,其链接在所有嵌入处失效,删除前应先确认。本地服务器仅在开启文件写入参数时才能修改磁盘上的 README 文件。

安装

在 SourceWeft 中

  1. 打开 控制台中的 GitHubCard,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Web executable,通过 Streamable HTTP。 远程服务在工作区中配置后即可从网页运行时运行。

交给智能体安装

把这段提示词粘贴到 Claude Code、Codex、Cursor 等智能体,或 SourceWeft 对话中。智能体会读取该服务器的安装指南,先向你展示发布者、端点和登录方式,经你同意后再把它添加到你的客户端。密钥不会写进任何命令。

阅读 https://sourceweft.com/mcp/com.githubcard%2Fmcp/install.md,并按其中说明把这个 MCP 服务器接入我的客户端。修改任何配置之前,先告诉我它的发布者、端点和登录方式,等我确认。不要把 API 密钥写进命令或我会提交的文件;问我密钥应从哪里获取。

查看智能体所依据的安装指南

其他 MCP 客户端

把它添加到你客户端的 mcpServers 配置中。

{
  "mcpServers": {
    "githubcard": {
      "type": "http",
      "url": "https://githubcard.com/mcp"
    }
  }
}

README

[GitHubCard]

GitHubCard MCP server

Let your AI assistant create GitHubCard images: profile and repository cards for READMEs, link previews and social posts, with live GitHub data.

  • Hosted: https://githubcard.com/mcp (Streamable HTTP). Nothing to install.
  • Local: npx -y @ghcardhq/ghcard mcp (stdio), from the ghcard CLI. It can also edit a README on your disk.

Ask things like:

Make a GitHubCard for my profile and add it to the top of my README.

Create a dark card for vercel/next.js I can use as a link preview.

Use the compact repo template, but with a #1e3a5f background and without the language widget.

Get an API key

Creating cards needs a free API key. Sign in at githubcard.com/dashboard and create one under API keys. It looks like ghc_live_….

Without a key, the server still lists templates, palettes and widget types, so you can try it before signing up.

Setup

Replace ghc_live_… with your key in the examples below.

Claude Code

bash
claude mcp add --transport http githubcard https://githubcard.com/mcp \  --header "Authorization: Bearer ghc_live_…"

There is also a Claude Code plugin that adds the server together with a GitHubCard skill: see ghcardhq/skills.

Claude Desktop

Settings → Connectors → Add custom connector, URL https://githubcard.com/mcp. Custom headers are not available there yet, so to pass your key, use the local server in claude_desktop_config.json instead:

json
{  "mcpServers": {    "githubcard": {      "command": "npx",      "args": ["-y", "@ghcardhq/ghcard", "mcp"],      "env": { "GHCARD_API_KEY": "ghc_live_…" }    }  }}

Cursor

~/.cursor/mcp.json:

json
{  "mcpServers": {    "githubcard": {      "url": "https://githubcard.com/mcp",      "headers": { "Authorization": "Bearer ghc_live_…" }    }  }}

VS Code

.vscode/mcp.json (VS Code asks for the key once and stores it securely):

json
{  "inputs": [    {      "id": "githubcard-key",      "type": "promptString",      "description": "GitHubCard API key",      "password": true    }  ],  "servers": {    "githubcard": {      "type": "http",      "url": "https://githubcard.com/mcp",      "headers": { "Authorization": "Bearer ${input:githubcard-key}" }    }  }}

Windsurf

~/.codeium/windsurf/mcp_config.json:

json
{  "mcpServers": {    "githubcard": {      "serverUrl": "https://githubcard.com/mcp",      "headers": { "Authorization": "Bearer ghc_live_…" }    }  }}

Codex CLI

~/.codex/config.toml:

toml
[mcp_servers.githubcard]url = "https://githubcard.com/mcp"bearer_token_env_var = "GHCARD_API_KEY"

Then export GHCARD_API_KEY=ghc_live_… in your shell.

Any other client

Remote: Streamable HTTP at https://githubcard.com/mcp, header Authorization: Bearer ghc_live_….

Local (stdio): command npx, args ["-y", "@ghcardhq/ghcard", "mcp"], env GHCARD_API_KEY. Add --allow-file-writes to the args to enable update_readme. Needs Node.js 20 or later.

Tools

ToolKeyWhat it does
create_cardyesCreate (or reuse) a card for a user or owner/repo. Returns SVG/PNG links and Markdown/HTML embed snippets. Uses one unit of the daily quota
validate_cardyesDry run of create_card: checks ids, Pro features and custom designs, uses no quota
list_templatesnoLayouts, filterable by scope (profile/repo), Free plan and widget types
list_palettesnoBackground palettes
list_componentsnoWidget types a card can contain
get_template_designnoA template's layout as an editable design document
get_card_designyesThe design document of one of your cards
list_cardsyesCards you have created
delete_cardyesDelete a card; its links stop working
get_usageyesYour plan and today's remaining quota
update_readmelocal onlyInsert or update the card in a Markdown file. Only with ghcard mcp --allow-file-writes

create_card is idempotent: the same inputs return the same card and link. Card images always show current GitHub data, so there is no need to recreate them.

Failed calls return isError: true with a stable code, a retryable flag and a hint telling the model what to do next.

Limits

PlanCards per day
Free100
Pro5000

The quota resets at 00:00 UTC. Failed calls are not counted. Free cards carry a small watermark. See pricing.

Links

License

MIT

来源:README.md,提交 6ea0491

工具

10

create_card

Create GitHub card

Create (or reuse) a published card image for a GitHub profile or repository. Returns svg/png URLs and markdown/html embed snippets. Idempotent; counts once against the daily quota.

输入参数designformatpalettesubject必填templatewatermark

validate_card

Check a card request

Dry run of create_card with the same inputs: checks template/palette ids, Pro features and the design document, without creating anything or using quota. warnings lists layers that reach outside the artboard (they would be clipped); fix those before create_card.

输入参数designformatpalettesubject必填templatewatermark

list_templates

List card templates

List card layouts with their ids, scope (profile/repo/all), size, widget types, and whether they need Pro.

输入参数scopewidgetsfreeOnly

list_palettes

List background palettes

List background palette ids accepted by create_card.

无需输入参数。

list_components

List widget types

List the widget (layer) types a design can contain, with the scope (profile/repo) each fits.

无需输入参数。

get_template_design

Get a template's design

Return a template's layout as an editable design document (artboard + layers). Costs no quota. Edit it and pass it to create_card as design.

输入参数palettesubjecttemplate必填

get_card_design

Get a card's design

Return the design document of one of the account's cards, to edit and re-submit through create_card as design (which creates a new card; the original is unchanged).

输入参数id必填

list_cards

List my cards

List cards this account created through the API, most recently requested first. Paginated with nextCursor.

输入参数limitcursor

delete_card

Delete a card

Permanently delete one of the account's cards. Its links stop working everywhere they are embedded. Confirm with the user first.

输入参数id必填

get_usage

Get plan and quota

Show the account's plan (free/pro) and how many cards it can still create today (cards.remaining, resets 00:00 UTC). The ai quota is reserved for future AI tools.

无需输入参数。

版本历史

2
  1. v0.2.1最新Nov 1, 2026
  2. v0.2.0Oct 31, 2026

评分

已满足适用检查项的 100%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通必需25 分
  • 已声明认证方式必需10 分
  • 已列出工具必需15 分
  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分