Skip to main content
Glama

read_contract

Read-onlyIdempotent

Read the documentation contract of a project: its version (the contract_version required when submitting changes), project_instructions, rules, and for each document its purpose, exclusions, update_when triggers, instructions, format_template, loading policy and size limit. Contains definitions, not document bodies.

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": {
      "project_id": "<project_id>"
    },
    "name": "read_contract"
  }
}

Input Schema

NameRequiredDescriptionDefault
project_idYes
result_offsetNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive and closed-world, so the safety profile is covered. The description adds genuinely new behavioral context: the payload is metadata/definitions only and not document bodies, and the returned contract_version is the token required for later submissions. It says nothing about truncation or paging behavior despite a result_offset parameter existing.

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?

Front-loaded with the core action, then a dense enumeration of returned fields, closing with the key exclusion. It is one long sentence but every clause carries information; no filler or restated title.

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?

With no output schema, the description does the work of describing return contents thoroughly, which is the right call. The remaining gap is input-side: the meaning of result_offset and any pagination semantics are left entirely unexplained for a tool that evidently can return large payloads.

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 0% for two parameters, so the description must compensate and does not: project_id and result_offset are never mentioned or explained. The phrase "contract_version" refers to a returned field, not an input, so it does not clarify either parameter.

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?

The description states a specific verb and resource ("Read the documentation contract of a project") and then enumerates exactly what the contract contains (version, project_instructions, rules, per-document purpose/exclusions/update_when/format_template/loading policy/size limit). The closing clause "Contains definitions, not document bodies" implicitly separates it from read_document and read_outline, though no sibling is named outright.

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

Usage Guidelines3/5

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

Usage is only implied: the parenthetical "the contract_version required when submitting changes" hints that this is a prerequisite read before submit_changes, but the description never says when to call it, when not to, or which sibling to use instead for document content. An agent must infer the workflow step from a side remark.

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