create_project_readme

Generate a README.md file for the project

SERVERGodot SOURCE@keeveeg/godot-mcp

Medium RISK CLASS

Category Write

Parameters 31 required

Recommended Rate-limitedsee the rule below

Registry record Grade F, identity unverified Pull the record →

This record as markdown: /tools/keeveeg-godot-mcp/create-project-readme.md

WHAT IT DOES

What create_project_readme does on Godot

AI agents use create_project_readme to create or update resources in Godot, usually the action step of a workflow, after the agent has gathered context. Every call changes real data in your Godot environment.

Parameter	Type	Required	Description
`content`	string	—	Custom README content (overrides template)
`template`	string	—	README template style
`project_path`	string	Yes	Path to the Godot project root

Parameters from the server's own tool schema.

RISK

Why create_project_readme is rated Medium

This tool creates a new README.md file, which is a reversible write operation. The file can be edited or deleted if needed. No data is destroyed, no code is executed, and no financial transactions occur. While sibling tools suggest this is part of a Godot game engine MCP server, this particular tool simply generates documentation, making it a straightforward Write category action.

From the tool's definition Tool name 'create_project_readme' and description 'Generate a README.md file for the project' indicate creation of a new file.

Risk signalsAccepts raw HTML/template content (content)

Attacks that exploit this kind of access

RECOMMENDED RULE

The rule that runs create_project_readme safely

PolicyLayer is an MCP gateway: it sits between your AI agents and Godot, and checks every tool call against a rule you set before the call runs. Nothing changes on the server itself. For create_project_readme, this is the rule to start with:

create_project_readme Rate-limited

create_project_readme stays usable, but capped: an agent stuck in a loop can't make hundreds of changes a minute. Everything else on the server is denied unless you say otherwise.

View as policy code

policy.json

{
  "version": "1",
  "default": "deny",
  "tools": {
    "create_project_readme": {
      "limits": [
        {
          "counter": "create_project_readme_rate",
          "window": "minute",
          "max": 30,
          "scope": "grant"
        }
      ]
    }
  }
}

LIMIT THIS TOOL → Instant setup, no code required.

The button opens the PolicyLayer dashboard: create your workspace, connect Godot, apply this rule, and every create_project_readme call is checked against it from then on.

FAQ

Questions about create_project_readme

What does the create_project_readme tool do? +

Generate a README.md file for the project. It is categorised as a Write tool in the Godot MCP Server, which means it can create or modify data. Consider rate limits to prevent runaway writes.

What parameters does create_project_readme accept? +

create_project_readme accepts 3 parameters: content, template, project_path. Required: project_path. The full parameter table on this page comes from the server's own tool schema.

How do I enforce a policy on create_project_readme? +

Register the Godot MCP server in PolicyLayer and add a rule for create_project_readme: 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 Godot. Nothing to install.

What risk level is create_project_readme? +

create_project_readme is a Write tool with medium risk. Write tools should be rate-limited to prevent accidental bulk modifications.

Can I rate-limit create_project_readme? +

Yes. Add a rate_limit block to the create_project_readme 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 create_project_readme completely? +

Set action: deny in the PolicyLayer policy for create_project_readme. 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 create_project_readme? +

create_project_readme is provided by the Godot MCP server (@keeveeg/godot-mcp). PolicyLayer sits as a proxy in front of this server to enforce policies before tool calls reach the server.

KEEP EXPLORING

More on Godot, and thousands of servers like it.

This server

All 321 Godot tools →

Across the catalogue

create_project on Stitch MCP Server →create_task on 0rca Dojo MCP Server →create-task on Kanban MCP Server →create_package_backup on Android Forensics ADB MCP Server → The MCP Attack Database →

Guides

Govern customer-ops agents →Argument validation →Scoped token →