Skip to main content
Glama

read_project

Read-onlyIdempotent

Return the lightweight map of the current project: project identity and settings, active timeline summary, timeline directory, and source-asset counts by type.

Use this first to orient yourself and obtain timeline ids. It does not return timeline tracks, items, gaps, markers, transcript text, rendered frames, or placed-item details.

Asset counts include reference-only assets, with byMediaPoolVisibility distinguishing hidden from visible. Hidden assets are available to you but absent from the user's media library; use browse_assets for their IDs and visibility labels.

Use preview_timeline for timeline structure, composed viewer frames, or bounded transcript context. Use inspect_item for a placed timeline item. Use browse_assets and inspect_asset for source assets.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "read_project"
  }
}

Input Schema

NameRequiredDescriptionDefault
projectIdNoProject for this call (full ID or unambiguous prefix). Explicit-timeline calls never change the target of later calls; legacy project selection applies otherwise.
timelineIdNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the bar is lower, and the description still adds real behavioral context: it is a lightweight orientation read, and asset counts include reference-only assets where byMediaPoolVisibility separates hidden from visible, with hidden assets noted as absent from the user's media library. It stops short of describing how to interpret the returned summary fields or any paging/limits, so it is strong but not exhaustive.

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?

Four short paragraphs, front-loaded with what is returned, then what is not, then the asset-count nuance, then the sibling routing. Every sentence carries distinct information with no restatement of the name 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?

No output schema exists, yet the description compensates by listing the returned sections and explicitly naming what is absent, which is what an agent needs before calling. The one meaningful hole is the undocumented timelineId parameter in an otherwise well-covered orientation tool.

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 coverage is only 50%: projectId carries its own description in the schema, but timelineId has no schema description at all, and the tool description never mentions either parameter or explains what passing a timelineId does to a project-level read. With half the parameters undocumented in structured fields, the description needed to compensate and does not.

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?

Opens with a specific verb and resource ('Return the lightweight map of the current project') and then enumerates the exact payload: project identity/settings, active timeline summary, timeline directory, and source-asset counts by type. The explicit exclusion list (no tracks, items, gaps, markers, transcript, frames) makes it unmistakable against preview_timeline and inspect_item.

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?

Gives a positive routing rule ('Use this first to orient yourself and obtain timeline ids') plus an explicit negative scope, then names three alternatives with the conditions that select each: preview_timeline for structure/frames/transcripts, inspect_item for placed items, browse_assets/inspect_asset for source assets. This is textbook when/when-not/alternative guidance.

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.