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 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/ More Data tools
Api Docs Generator
Return API documentation generated from a list of endpoints, as Markdown (with table of contents, request/response examples) or as an OpenAP
Csv To Json
Parse CSV text into an array of objects keyed by the header row.
Graphql To Typescript
Convert a GraphQL SDL schema into TypeScript type definitions and return the generated code with counts of emitted types, enums, and inputs.
Html Table To Json
Convert an HTML <table> into JSON — an array of objects keyed by the header row, or an array of row arrays.
Jq Playground
Returns the result of running a jq-style filter over a JSON document.
Json Comparer
Returns a git-style line diff of two JSON documents after both are pretty-printed with 2-space indentation.
Json Diff
Returns the semantic differences between two JSON documents as a list of added, removed and modified paths with their old and new values, pl
Json Faker
Returns an array of fake JSON records built from a field list, for testing and prototyping.