Skip to main content
Glama

README generator module with pytest tests

submit_readme_generation
Idempotent

Produce a standard-library Python module that generates a Markdown README from function signatures, plus pytest tests. Choose this when a Markdown README must be produced from a list of function signatures, one section each. Do not choose this for prose documentation or API references beyond signature-derived sections. Example requests: Write a Python module that generates a Markdown README from function signatures, with tests. | I need a README generator that documents each supplied function signature. | Generate a README-generator module and prove it with pytest.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "inputs": "<inputs>",
      "authorized_by": "<authorized_by>"
    },
    "name": "submit_readme_generation"
  }
}

Input Schema

NameRequiredDescriptionDefault
inputsYes
quote_idNoThe quote_id returned by POST /v1/jobs. Required to authorize a priced capability; the service rejects a priced job that does not name the quote it issued.
authorized_byYesIdentifier of the human or agent authorizing this job.
accepted_priceNoThe amount accepted, exactly as quoted (for example "5.00" or 5). Checked against the stored quote, so a price that moved between quote and authorize is refused rather than silently absorbed. Optional, but sent to make the acceptance explicit.

Output Schema

NameRequiredDescriptionDefault
quoteNo
stateYes
job_idYes
artifactsNo
access_tokenNoPer-job credential. Present it as the X-Job-Token header to read the job or list it. Keep it; it is the only credential for this job.
verificationNoIndependent verification. verification.ok = false means the job failed, not a partial success.
capability_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true, destructiveHint=false, openWorldHint=false, so the description only needs to add context. It adds the standard-library constraint, which usefully bounds the generated code, but says nothing about the priced/quote authorization flow, what happens when accepted_price mismatches, or failure modes — meaningful for a job-submitting mutation.

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

Conciseness4/5

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

Purpose is front-loaded, and the choose/do-not-choose pair is tight. The three example requests largely restate the first sentence and add little an agent can act on, though they do no harm.

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

Completeness3/5

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

An output schema exists, so return values needn't be described, and the core generative intent is clear. However, for a four-parameter, nested-schema, priced job-submission tool whose siblings include preflight_job and submit_job, the description omits the quote/authorization workflow an agent must satisfy.

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

Parameters3/5

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

With 75% schema description coverage and full nested-object descriptions for module_name, function_name, and template, the schema does most of the work, so baseline 3 applies. The description mentions signatures and tests but adds no meaning about the template enum-like pattern, quote_id, accepted_price, or authorized_by.

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 first sentence gives a specific verb and resource — produce a standard-library Python module that generates a Markdown README from function signatures, plus pytest tests. The scope clause ('one section each') and the exclusion of prose documentation cleanly separate it from adjacent siblings like submit_markdown_table_rendering or submit_python_utility_module.

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?

Explicit when-to-use ('Choose this when a Markdown README must be produced from a list of function signatures') and when-not ('Do not choose this for prose documentation or API references beyond signature-derived sections'). It stops short of naming an alternative tool or explaining the required workflow prerequisite (obtain a quote_id, possibly via preflight_job) before submission.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources