Skip to main content
Glama

create_or_update_index

Creates or updates the contract file that defines how agents interpret project sources and map queries to documentation.

Instructions

Creates or updates the index.md file in .project/ directory. This is the contract file that defines how agents should interpret sources. Use this when setting up project structure or updating source mappings.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
contentYesThe contract content to add. Should define source mappings and how agents should interpret different queries.
replaceNoIf true, replaces the entire file. If false (default), merges with existing content.
Behavior3/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. It mentions the tool 'creates or updates' a file, implying mutation, but doesn't specify permissions needed, error handling, or what happens if the file doesn't exist. It adds some context about the file's role as a contract, but lacks details on behavioral traits like side effects or response format.

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 core purpose and followed by usage guidance. Every sentence adds value without redundancy, making it efficient and well-structured for quick understanding.

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?

Given no annotations and no output schema, the description is moderately complete. It covers the tool's purpose and usage context but lacks details on behavioral aspects like error conditions or return values. For a mutation tool with 2 parameters, it provides adequate basics but could benefit from more operational transparency.

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 both parameters ('content' and 'replace') thoroughly. The description adds no additional parameter semantics beyond what's in the schema, such as format examples or constraints. Baseline 3 is appropriate when schema coverage is high.

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 verb ('creates or updates'), resource ('index.md file in .project/ directory'), and purpose ('contract file that defines how agents should interpret sources'). It distinguishes this from sibling tools by focusing on project structure setup and source mappings, unlike other tools that handle tasks, decisions, or roadmaps.

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

Usage Guidelines5/5

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

The description explicitly states when to use this tool: 'Use this when setting up project structure or updating source mappings.' This provides clear context for usage, distinguishing it from other file management or project tools in the sibling list.

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/pouyanafisi/project-mcp'

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