Skip to main content
Glama

project_status

Read-only

Reads Git status and diff stats for the active workspace, and lists top-level files when it is not a Git repository.

Instructions

读取项目 Git 状态和差异统计;非 Git 目录则列出顶层文件。

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workspaceNo当前原生聊天所打开工作区的绝对路径;每次调用按当前聊天动态选择,不绑定安装目录。

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior4/5

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

Annotations declare readOnlyHint and openWorldHint, so the safety profile is already covered. The description adds fallback behavior for non-Git directories listing top-level files, which is useful context beyond annotations, though it omits details like permissions or error handling.

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?

A single sentence that is front-loaded with the primary function and fallback. It is appropriately sized with zero wasted words.

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?

Complete for a simple read-only status tool with an optional workspace parameter; the description covers both Git and non-Git cases. It lacks return format details, but no output schema exists and the function is clear.

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 coverage is 100% and the single workspace parameter is fully documented in the schema. The description adds no parameter-specific meaning beyond the schema, so the baseline of 3 applies.

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?

States a specific verb (读取) and resources (Git 状态和差异统计), plus a fallback for non-Git directories. Distinguishes from sibling read_project_file by focusing on project-level status rather than file contents.

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?

Implies usage for checking project Git status, but does not explicitly state when to use this versus read_project_file or other status tools. No exclusions or alternatives are named.

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