Skip to main content
Glama

append_api_contract

Store the durable contract for an API endpoint after creation or modification, capturing method, path, auth, request/response shapes, side effects, frontend usage, and related files.

Instructions

Use this tool after creating or modifying an API endpoint. Store only the durable endpoint contract: method, path, auth, request shape, response shape, side effects, frontend usage, and related files. Do not store full source code.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
authNoAuthentication/authorization requirements (e.g., "Bearer token, admin role").
nameYesHuman-readable name for the endpoint (e.g., "Create User").
pathYesAPI path (e.g., "/api/v1/users").
methodYesHTTP method: GET, POST, PUT, PATCH, DELETE.
purposeYesWhat this endpoint does and why it exists.
requestNoRequest body shape or query parameters as concise text or a code block.
responseNoResponse shape as concise text or a code block.
sideEffectsNoSide effects like sending emails, updating caches, or triggering webhooks.
relatedFilesNoPaths to related source files (relative to project root).
frontendUsageNoHow the frontend consumes this endpoint.
Behavior3/5

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

No annotations are provided, so the description must carry the behavioral burden. It describes what to store but does not disclose whether the tool overwrites or appends, or any side effects. The description is adequate but lacks details on behavior beyond storage.

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, front-loaded with the primary usage scenario. Every sentence adds value without redundancy. Very concise and well-structured.

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

Completeness4/5

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

Given the 10 parameters and no output schema, the description provides a clear overview of the tool's purpose and what the contract should contain. It covers the essential categories. Minor missing detail on formatting, but overall complete enough.

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 100%, so the schema already documents all parameters. The description lists the key fields (method, path, auth, etc.) but adds little extra meaning beyond that. Baseline score of 3 applies.

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 clearly states the tool's purpose: 'Use this tool after creating or modifying an API endpoint. Store only the durable endpoint contract.' It specifies the verb (store) and resource (API contract), and distinguishes itself by explicitly excluding full source code.

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 provides explicit when-to-use guidance: 'after creating or modifying an API endpoint.' It also tells what not to store ('Do not store full source code.'). However, it does not directly contrast with sibling tools, though the context makes it clear that this is for API contracts specifically.

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/gregoire-renaldo/memory-mcp'

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