English Français العربية

GitHubCard

Registre officiel Outils de développement

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

Code source Site web Documentation

Installation

Ajoutez ceci à la configuration MCP de votre client (Claude Desktop : claude_desktop_config.json ; Cursor : .cursor/mcp.json ; VS Code et les autres utilisent la même forme « mcpServers »).

Remote (streamable-http)
Claude Code 
claude mcp add --transport http githubcard 'https://githubcard.com/mcp' --header 'Authorization: <"Bearer " followed by an API key from https://githubcard.com/dashboard. Needed to create cards; templates, palettes and components work without it.>'
Configuration JSON (Claude Desktop, Cursor, VS Code) 
{
    "mcpServers": {
        "githubcard": {
            "type": "http",
            "url": "https://githubcard.com/mcp",
            "headers": {
                "Authorization": "<\"Bearer \" followed by an API key from https://githubcard.com/dashboard. Needed to create cards; templates, palettes and components work without it.>"
            }
        }
    }
}
NPM package @ghcardhq/ghcard
Claude Code 
claude mcp add githubcard -e 'GHCARD_API_KEY=<your ghcard_api_key>' -- npx -y @ghcardhq/ghcard@0.2.0 mcp
Configuration JSON (Claude Desktop, Cursor, VS Code) 
{
    "mcpServers": {
        "githubcard": {
            "command": "npx",
            "args": [
                "-y",
                "@ghcardhq/ghcard@0.2.0",
                "mcp"
            ],
            "env": {
                "GHCARD_API_KEY": "<your ghcard_api_key>"
            }
        }
    }
}

Variables d'environnement

  • GHCARD_API_KEY secret API key from https://githubcard.com/dashboard. Needed to create cards.

Documentation

Tirée du README du projet sur GitHub, actualisée chaque semaine. Les liens ouvrent GitHub.

Sommaire
  1. GitHubCard MCP server
  2. Get an API key
  3. Setup
  4. Tools
  5. Limits
  6. Links
  7. License

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
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:

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

~/.cursor/mcp.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):

{
  "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:

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

~/.codex/config.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.

License

MIT

Questions fréquentes

Qu'est-ce que GitHubCard ?

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

Comment installer GitHubCard ?

Il fonctionne comme serveur distant. Dans Claude Code : claude mcp add --transport http githubcard 'https://githubcard.com/mcp' --header 'Authorization: <"Bearer " followed by an API key from https://githubcard.com/dashboard. Needed to create cards; templates, palettes and components work without it.>'. Pour les autres clients, collez la configuration JSON de cette page dans leurs réglages MCP.

Faut-il une clé API pour GitHubCard ?

Oui. Il attend GHCARD_API_KEY, Authorization, à renseigner dans sa configuration.

GitHubCard est-il open source ?

Oui. Son code est sur GitHub sous licence MIT.

Qui maintient GitHubCard ?

Il est publié par ghcardhq. AI.tn le référence sans le maintenir ni le recommander.

Issu du registre MCP officiel. Être listé n'est pas une recommandation : vérifiez le code et les permissions d'un serveur avant de lui donner accès à vos données.