Json To Readme

Data REST API MCP

Generate a README.md (title, shields.io badges, description, demo/docs links, features, installation, usage, contributing, author, license) from JSON such as {"name","description","features":[...],"installation":[...],"license":"MIT"}. Returns the Markdown and the list of sections included.

This page documents the HTTP endpoint POST /api/tools/json-to-readme/execute. See the MCP reference →

Call it over REST

POST https://api.findutils.com/api/tools/json-to-readme/execute · no API keys · 60 requests/min per IP

Execute — verified arguments

curl -X POST https://api.findutils.com/api/tools/json-to-readme/execute \
  -H "Content-Type: application/json" \
  -d '{
    "json": "{\"name\":\"Awesome Project\",\"description\":\"A fast tool for developers.\",\"features\":[\"Fast\"],\"installation\":[\"npm install awesome\"],\"license\":\"MIT\"}"
  }'

Parameter schema for this endpoint

curl https://api.findutils.com/api/tools/json-to-readme

Interactive docs · OpenAPI 3.1 spec · All REST tools

Input schema

Argument Type Required Description
json string yes README JSON: {"name": string, "description": string, "badges"?: [{"label","message","color"?}], "logo"?, "installation"?: string[], "usage"?, "features"?: string[], "contributing"?, "license"?, "author"?: {"name","github"?,"twitter"?,"website"?}, "demo"?, "documentation"?}.

Example arguments (verified)

{
  "json": {
    "name": "Awesome Project",
    "description": "A fast tool for developers.",
    "features": [
      "Fast"
    ],
    "installation": [
      "npm install awesome"
    ],
    "license": "MIT"
  }
}

Arguments that carry JSON as a string are shown decoded for readability. The Copy button copies the exact wire arguments.

Also an MCP tool

Claude, Cursor, and any MCP client can call this tool as findutils:json_to_readme after one connect command.

Connect once

claude mcp add findutils --transport http https://mcp.findutils.com/
Open the MCP reference for Json To Readme →

More Data tools