Skip to main content
Glama

read_project

Retrieve the full contents of a Forgejo project board, including all columns and cards. Use state, milestone, and pagination options to filter results and limit network usage.

Instructions

Full content of an entire board: every column and every card's content.

Args: state: 'open', 'closed', or 'all' (default). milestone: optional milestone id to restrict to. limit: max cards to read this call (None = no limit); offset to page.

⚠️ Network- and token-expensive. Avoid unless asked or necessary; use limit/offset to cap cost.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
repoYes
limitNo
ownerYes
stateNoall
offsetNo
milestoneNo
project_idYes

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations provided, the description carries the full behavioral disclosure burden. It warns that the call is network- and token-expensive and that it reads every column and card, which is valuable beyond what the name implies. It does not discuss auth requirements or the exact response format, but it covers the most important behavioral caveat for this read operation.

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 compact and front-loaded: the purpose is stated first, followed by a tight Args list and a clear cost warning. Every sentence earns its place, with no repetition of schema details or filler.

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?

For a tool with no output schema, no annotations, and seven parameters, the description provides enough context to invoke it correctly: full board scope, arg semantics, defaults, and cost mitigation. It does not describe the exact nested response shape, but 'every column and every card's content' gives a reasonable expectation of the return payload.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must explain parameters, and it does for the non-obvious ones: state values, milestone filtering, limit as max cards, and offset for paging. Required params like owner, repo, and project_id are self-explanatory, so the coverage is sufficient despite not naming every parameter explicitly.

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 opens with a specific and complete statement: 'Full content of an entire board: every column and every card's content.' This clearly identifies the resource and scope, and the emphasis on 'entire board' separates it from sibling tools like read_card and read_column.

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 gives clear context: this is a heavy, expensive operation, and it should be avoided unless explicitly requested or necessary. It also suggests using limit/offset to cap cost. It does not name alternatives like read_card or read_column for smaller reads, so it stops short of a full when-to-use-versus-alternatives explanation.

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

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/UnwantedForeignCloudProvider/ForgejoProjectsMCP'

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