Skip to main content
Glama

contract_docs

Generate documentation for any verified EVM smart contract. Returns function descriptions, risk flags, interaction patterns, and security posture.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
chainNoBlockchain networkethereum
addressYesContract address
focusFunctionsNoSpecific functions to document

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.3/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It only mentions output content and the 'verified' constraint; it does not state whether the operation is read-only, how it handles unverified or invalid addresses, or any other behavioral traits such as failure modes.

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 concise sentences with the primary action front-loaded and no filler. The return-value list is informative without redundancy.

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?

The core invocation is clear: address is required, chain defaults to ethereum, and output categories are named. But with no output schema and no annotations, the description does not fully cover return-value shape, failure behavior, or routing against sibling tools. It is adequate but leaves meaningful gaps.

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 — address, chain enum, and focusFunctions. The description adds no parameter-level meaning beyond what the schema provides, so the baseline score of 3 is appropriate.

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 uses a specific action ('Generate documentation') and names the target resource ('any verified EVM smart contract'), plus it lists concrete outputs like risk flags and security posture. It is clear about what the tool produces, though it does not explicitly differentiate itself from sibling tools such as code_review or contract_monitor.

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?

The phrase 'any verified EVM smart contract' implies the tool is for generating contract documentation, giving a broad use case. However, it provides no guidance on when to prefer this tool over siblings like code_review or contract_monitor, and no exclusions or prerequisites beyond 'verified'.

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.