Skip to main content
Glama

Generate aps.txt

generate_aps_txt
Read-onlyIdempotent

Generate a signed aps.txt governance file for your domain, defining AI training, inference, and redistribution terms with revocation and MCP endpoint details.

Instructions

Generate a signed aps.txt file for site-wide governance. Like robots.txt but cryptographically signed with terms, revocation endpoint, and MCP upgrade path.

Input Schema

NameRequiredDescriptionDefault
domainYesDomain this declaration covers (e.g. theagenttimes.com)
trainingNo
inferenceNo
publicKeyYesPublisher's Ed25519 public key (hex)
privateKeyYesPublisher's Ed25519 private key (hex)
mcpEndpointNo
publisherNameYesHuman-readable publisher name
redistributionNo
revocationEndpointNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv4.0.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • removedInput schema / additionalProperties
      Removed value: -false
  2. Addedv2.8.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already establish the safe, idempotent, non-destructive, closed-world profile, so the description's remaining burden is modest. It adds useful artifact context (the file is cryptographically signed, and contains terms, a revocation endpoint, and an MCP upgrade path), but says nothing about the signing key sensitivity or how the signature is produced, so it only modestly exceeds what annotations provide.

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?

Two tight sentences with the core action front-loaded and the analogy second to build intuition. No filler, though the second sentence is doing double duty as both explanation and parameter hint.

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?

For a 9-parameter tool with no output schema and 44% schema coverage, the description is thin: it never states that the tool returns the signed file contents, how the three policy enums interact, or what the caller must supply versus omit. It conveys the concept well but leaves multiple call-shaping details unaddressed.

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?

Schema description coverage is only 44%, so several parameters (the training/inference/redistribution enums, mcpEndpoint) carry no documentation anywhere. The description partially compensates by naming 'terms', 'revocation endpoint', and 'MCP upgrade path', which hints at those inputs, but it never explains the enum values or flags that privateKey is a sensitive credential.

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

Purpose4/5

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

Specific verb (generate) plus specific artifact (a signed aps.txt file), and the robots.txt analogy makes the concept immediately legible. It implicitly separates itself from the sibling verify_aps_txt, but it never names that sibling or explicitly states it is the producer-side counterpart rather than the checker.

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

Usage Guidelines2/5

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

No when-to-use guidance, no prerequisites, and no alternatives named despite a crowded sibling set (verify_aps_txt, verify_governance_block, create_disclosure, sign_charter). The agent must infer that this is the authoring step and that verify_aps_txt is the later verification step.

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

Deploy Server

Other Tools