Skip to main content
Glama

Attach docs as assets

attach_docs_as_assets
Destructive

Copy documentation files into a package and register them in its manifest, so README and usage notes travel with the component after make_portable_tox.

Instructions

Copy documentation files into a package and register them in its manifest's docs list. Use after make_portable_tox to bundle a README or usage notes with a component so they travel with it; writes into the package folder (destructive).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
docsNo
asset_dirNodocs
help_snapshotNoAttach an exact-build installed OfflineHelp snapshot for the packaged TOX.
manifest_pathYes
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare destructiveHint=true, but the description adds that the tool 'writes into the package folder (destructive)' and registers docs in the manifest, specifying exactly what gets modified. This goes beyond the annotation and provides useful behavioral context with no contradiction.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences, action-first, with usage context and a destructive warning. Every sentence earns its place with no redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

While purpose and usage are clear, the description leaves significant gaps around parameter semantics, especially for the help_snapshot object and the expected format of docs paths. With no output schema and only 25% schema coverage, an agent lacks sufficient detail to confidently invoke the tool with all parameters.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 25%, and the description does not explain the meaning of docs, asset_dir, or manifest_path beyond the vague 'documentation files.' It fails to compensate for the low schema coverage with parameter-level guidance.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states 'Copy documentation files into a package and register them in its manifest's docs list,' which is a specific verb+resource combination. It distinguishes the tool from siblings by explicitly referencing make_portable_tox and the package manifest context.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly says 'Use after make_portable_tox' and explains the intended outcome (so docs travel with the component), giving clear context. However, it does not specify when not to use the tool or mention alternatives like bundle_dependencies or collect_project_assets.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/lucasmaher-hash/touch-designer-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server