GitHub repo readme API

The README markdown a GitHub repository serves.

Ask your agent

“Call github/repo/readme with repo vercel/next.js and summarize what comes back.”

Works in any MCP client connected to https://data.openkrill.app/mcp. Install in one line.

Path: github/repo/readme
MCP tool: call_endpoint
Credits: 5
Cache: 10 min

Parameters

repostring, required	Repository, owner/name
charsinteger, optional	200-40000 characters of markdown, default 20000

Response

data.resources[] uses the same keys as every other platform: author, engagement, metadata, with GitHub-only fields under extras. A failed upstream call is never billed.

More GitHub tools

MCP tool call

{
  "name": "call_endpoint",
  "arguments": {
    "path": "github/repo/readme",
    "params": {
      "repo": "vercel/next.js"
    }
  }
}

curl

curl "https://data.openkrill.app/v1/github/repo/readme?repo=vercel%2Fnext.js" \
  -H "x-api-key: YOUR_API_KEY"

Response

{
  "success": true,
  "platform": "github",
  "endpoint": "github/repo/readme",
  "data": {
    "resources": [
      { "id": …, "title": …, "text": …, "url": …,
        "author": {…}, "engagement": {…},
        "metadata": {…}, "extras": {…} }
    ]
  },
  "credits_used": 5,
  "cached": false
}