Skip to main content
Glama

Get Project Overview

get_project_overview
Read-onlyIdempotent

List available projects or inspect a selected project's file tree, entry docs, ADRs, and working tree status for a quick Tier 1 overview.

Instructions

Lấy thông tin tổng quan Tier 1: danh sách dự án (khi không truyền project_id) hoặc cây file, tài liệu cơ sở (entry_docs), ADRs và trạng thái working tree (tree_state).

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": "get_project_overview"
  }
}

Input Schema

NameRequiredDescriptionDefault
subpathNo
project_idNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and idempotentHint, so the safety profile is covered. The description adds behavioral value beyond that by disclosing the two operating modes and which artifacts (entry_docs, ADRs, tree_state) surface in the project-scoped mode, though it says nothing about permissions or the size of what is returned.

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?

A single front-loaded sentence with the mode switch placed before the payload enumeration; there is no filler. The density of domain jargon (Tier 1, entry_docs, tree_state) makes it slightly harder to parse but every clause carries information.

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?

An output schema exists, so return values need not be fully spelled out, and the description does outline both modes. However, with two undocumented parameters and no mention of access prerequisites or how subpath interacts with the tree, an agent still lacks enough to call it confidently in the scoped mode.

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 0%, so the description must carry parameter meaning. It explains project_id's semantics well (absence switches to project-list mode), but the subpath parameter is never mentioned, leaving an agent to guess how to descend into the tree.

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 names a specific verb ('Lấy thông tin tổng quan') and resource (project overview) and explicitly enumerates the payload: project list, file tree, entry_docs, ADRs, tree_state. It does not distinguish itself from the siblings inspect_evidence or investigate_codebase, so it stops short of a 5.

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?

It gives an explicit branch condition: omit project_id to get the project list, supply it to get the file tree and supporting docs. That is genuine when-to-use guidance for the tool's two modes, but it offers no exclusions or comparison against the sibling tools.

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