Skip to main content
Glama
Sign In

GitShine

by com.gitshine
OverviewDiscussionsAdmin

README stats card

get_readme_card
Read-onlyIdempotent

The Markdown line that puts GitShine's animated stats card (contribution graph, streaks, stars, top languages) on a GitHub profile README, with step-by-step instructions for adding it. Free, no token.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "username": "<username>"
    },
    "name": "get_readme_card"
  }
}

Input Schema

NameRequiredDescriptionDefault
themeNoauto (default) follows the viewer's light or dark mode; transparent has no background; dimmed, tokyonight, dracula and catppuccin are editor palettes.
layoutNofull (default): graph, totals, streaks and languages. Half width (pair two side by side): compact (streak), languages, week (contributions by weekday), repos (most-starred repositories). Full width: years (a bar per year), sky (the year as a night sky), wrapped (this year so far).
usernameYesA GitHub username, @handle or profile URL (organizations aren't supported).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / layout / description
      Previous value: -"compact is a smaller streak card; languages is a top-languages card (both half width, so they pair side by side)."New value: +"full (default): graph, totals, streaks and languages. Half width (pair two side by side): compact (streak), languages, week (contributions by weekday), repos (most-starred repositories). Full width: years (a bar per year), sky (the year as a night sky), wrapped (this year so far)."
    • changedInput schema / properties / layout / enum
      Previous value: -[
-  "full",
-  "compact",
-  "languages"
-]New value: +[
+  "full",
+  "compact",
+  "languages",
+  "week",
+  "repos",
+  "years",
+  "sky",
+  "wrapped"
+]
  2. Changed4 schema fields changed
    • changedInput schema / properties / layout / description
      Previous value: -"compact is a smaller streak card."New value: +"compact is a smaller streak card; languages is a top-languages card (both half width, so they pair side by side)."
    • changedInput schema / properties / layout / enum
      Previous value: -[
-  "full",
-  "compact"
-]New value: +[
+  "full",
+  "compact",
+  "languages"
+]
    • changedInput schema / properties / theme / description
      Previous value: -"auto (default) follows the viewer's light or dark mode."New value: +"auto (default) follows the viewer's light or dark mode; transparent has no background; dimmed, tokyonight, dracula and catppuccin are editor palettes."
    • changedInput schema / properties / theme / enum
      Previous value: -[
-  "auto",
-  "dark",
-  "light",
-  "night"
-]New value: +[
+  "auto",
+  "dark",
+  "light",
+  "night",
+  "transparent",
+  "dimmed",
+  "tokyonight",
+  "dracula",
+  "catppuccin"
+]
  3. First observed

TDQS

A3.8/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already cover read-only, idempotent, non-destructive and closed-world behavior, so the description only needs to add what they cannot. It does: the return value is a Markdown snippet plus step-by-step installation instructions, and 'Free, no token' discloses that no authentication is required — a genuinely non-obvious operational fact.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, front-loaded with what the tool returns and followed by the practical facts (instructions included, free, no token). Nothing is redundant or padded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a three-parameter read-only tool with a fully described schema and annotations, the description covers the deliverable, the included instructions, and the auth situation, so an agent can call it correctly without guessing. The only minor gap is a lack of guidance on which layout/theme to prefer for a given intent.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% and both enums are documented in detail (theme palettes, layout widths), so the schema carries parameter meaning entirely. The description only echoes the card's content areas and adds no syntax, defaults, or layout-selection advice beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a concrete deliverable — the Markdown line for GitShine's animated stats card on a profile README, listing what the card shows (contribution graph, streaks, stars, top languages) and that it ships with usage instructions. That clearly separates it from a raw-stats or repo-card tool, though it never explicitly contrasts itself with the sibling get_repo_card, which also emits README snippets.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage context is implied by 'puts ... on a GitHub profile README' — an agent can infer it is the tool for adding the card — but there is no explicit when-to-use versus when-to-use-a-sibling guidance and no exclusions (e.g., organizations are unsupported is only noted in the schema).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All GitShine toolsInspect
Try in Browser
Claude Code, inside the Godot 4 editorFlockbay puts an AI agent in the real Godot 4 editor: it writes GDScript, runs your game and fixes what breaks. Free, or bring your own Claude Code or Codex.flockbay.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources