Skip to main content
Glama

describe_project

Read-only

Describe the project the way the copilot is told about it: every file, what it carries and which tool reads it, which files are indexed or paired with each other, and the codon-usage tables a tool resolves by name. Over the API or MCP it describes the files sent as _files; in the app it describes the open project.

Input Schema

NameRequiredDescriptionDefault
titleNothe project's name, for the header line when the files were sent with the call. In the app the open project's own title is used.
_filesNoThe project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name.
_subjectNoThe record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several.

Output Schema

NameRequiredDescriptionDefault
textYesthe project section exactly as the copilot receives it, one line per fact
filesYeshow many files it describes
unreadYesfiles sent with the call that the importer could not read, each with its reason. They are not in the project, exactly as a file the app refuses at import is not

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, openWorldHint=false, so the safety profile is covered. The description adds genuine value beyond that: the dual API-vs-app sourcing behavior and a concrete enumeration of what the report contains (file carriers, reading tools, pairing, codon tables).

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?

Two sentences, front-loaded with 'Describe the project' and no wasted preamble. The first sentence is dense and list-like but each clause conveys real content; the second earns its place by disambiguating the two operational contexts.

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?

Given an output schema exists (so return shape needn't be explained) and 3 nested params fully documented in the schema, the description is complete enough: it conveys the source of data (API _files vs open project) and the scope of what is described. Minor gap is the absence of any sequencing/relationship to related read tools.

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 title, _files, and _subject in depth. The description echoes _files ('the files sent as _files') and title implicitly but adds no format or shape detail beyond the schema. Baseline 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?

States a specific verb (describe) and resource (project) and elaborates the exact content returned: files, what they carry, the tool that reads them, indexing/pairing, and codon-usage tables. Clear purpose, though it doesn't explicitly name a sibling alternative to distinguish itself from tools like get_open_record or list_library.

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?

It explains the two contexts of use — 'Over the API or MCP it describes the files sent as _files; in the app it describes the open project' — which is genuine context, but it does not state when to choose this tool over alternatives or any prerequisite/exclusion. Usage is implied rather than directed.

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