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 分