generate_readme
Produce a Markdown project document for any COMP or project: family/type counts, custom-parameter table, inputs/outputs, child inventory, external file dependencies, and an optional preview thumbnail of the output TOP. Use
This record as markdown: /tools/hybridlabor-api-aos/generate-readme.md
What generate_readme does on Aos
AI agents call generate_readme to retrieve information from Aos without modifying anything. It is typically the context-gathering step in research, monitoring, and reporting workflows, before the agent takes action elsewhere.
Why generate_readme is rated Low
The tool inspects and reads the structure of a TouchDesigner project and generates documentation from it. It queries metadata (counts, parameters, dependencies) and produces a Markdown document. No data is modified, executed, or deleted. The only output is a generated document, making this a Read operation with low blast radius.
From the tool's definition Produce a Markdown project document... family/type counts, custom-parameter table, inputs/outputs, child inventory, external file dependencies, and an optional preview thumbnail
Attacks that exploit this kind of access
The rule that runs generate_readme safely
PolicyLayer is an MCP gateway: it sits between your AI agents and Aos, and checks every tool call against a rule you set before the call runs. Nothing changes on the server itself. For generate_readme, this is the rule to start with:
generate_readme is read-only, so it stays allowed. Everything else on the server is denied unless you say otherwise.
The button opens the PolicyLayer dashboard: create your workspace, connect Aos, apply this rule, and every generate_readme call is checked against it from then on.
Questions about generate_readme
Produce a Markdown project document for any COMP or project: family/type counts, custom-parameter table, inputs/outputs, child inventory, external file dependencies, and an optional preview thumbnail of the output TOP. Use. It is categorised as a Read tool in the Aos MCP Server, which means it retrieves data without modifying state.
Register the Aos MCP server in PolicyLayer and add a rule for generate_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 Aos. Nothing to install.
generate_readme is a Read tool with low risk. Read-only tools are generally safe to allow by default.
Yes. Add a rate_limit block to the generate_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.
Set action: deny in the PolicyLayer policy for generate_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.
generate_readme is provided by the Aos MCP server (@hybridlabor-api/aos). PolicyLayer sits as a proxy in front of this server to enforce policies before tool calls reach the server.
More on Aos, and thousands of servers like it.
This server
Across the catalogue