generateReadme

根据项目信息生成 README Markdown(只读返回)

Server Readme-builder-mcp mingzhu3377/readme-builder-mcp
Category Read
Risk class Low
Parameters 00 required

What generateReadme does on Readme-builder-mcp

AI agents call generateReadme to retrieve information from Readme-builder-mcp without modifying anything — typically the context-gathering step in research, monitoring, and reporting workflows, before the agent takes action elsewhere.

Why generateReadme needs a policy

The tool generates a README markdown string and returns it without writing to disk. The description explicitly states it is read-only ('只读返回'), meaning no files are created or modified. The sibling tool 'writeFile' handles the actual write operation, confirming this tool only produces output in memory.

From the tool's definition 根据项目信息生成 README Markdown(只读返回)— explicitly states '只读返回' (read-only return)

Questions about generateReadme

What does the generateReadme tool do? +

根据项目信息生成 README Markdown(只读返回). It is categorised as a Read tool in the Readme-builder-mcp MCP Server, which means it retrieves data without modifying state.

How do I enforce a policy on generateReadme? +

Register the Readme-builder- MCP server in PolicyLayer and add a rule for generateReadme: allow, deny, rate-limit, or require approval. Point your MCP client at the PolicyLayer proxy URL and the rule is enforced on every call, before it reaches Readme-builder-mcp. Nothing to install.

What risk level is generateReadme? +

generateReadme is a Read tool with low risk. Read-only tools are generally safe to allow by default.

Can I rate-limit generateReadme? +

Yes. Add a rate_limit block to the generateReadme rule in your PolicyLayer policy. For example, setting max: 10 and window: 60 limits the tool to 10 calls per minute. Rate limits are tracked per agent session and reset automatically.

How do I block generateReadme completely? +

Set action: deny in the PolicyLayer policy for generateReadme. The AI agent will receive a policy violation error and cannot call the tool. You can also include a reason field to explain why the tool is blocked.

What MCP server provides generateReadme? +

generateReadme is provided by the Readme-builder- MCP server (mingzhu3377/readme-builder-mcp). PolicyLayer sits as a proxy in front of this server to enforce policies before tool calls reach the server.

// LOOK UP ANOTHER SERVER

Every MCP server has a record like this.

Type a name, get the same breakdown: verified identity, auth posture, risk grade, capabilities, recommended policy.

Teams ship this data inside their own products. See what a licence covers →

// GET IN TOUCH

Have a question or want to learn more? Send us a message.

Message sent.

We'll get back to you soon.