Skip to main content
Glama

check_repository_status

Query a repository's indexing status on Zread.ai to determine if its documentation is accessible.

Instructions

检查仓库索引状态。

查询指定仓库在 Zread.ai 的索引状态和基本信息。 返回的 status 字段: "success"(已索引), "progress"(索引中)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
repo_pathYes仓库路径,格式: owner/repo
Behavior3/5

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

No annotations provided, so description carries full burden. It reveals the return status field and hints at '基本信息', but lacks disclosure on error handling, authentication, or rate limits. Adequate for a simple read operation but could be more explicit.

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?

Extremely concise: three sentences with no filler. Front-loaded with the core purpose. Every sentence adds value.

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 the tool's simplicity (one required param, no output schema), the description covers the main functionality and return status. Minor gap: no mention of error cases or what '基本信息' includes. Nearly complete.

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?

Input schema has 100% coverage with description for repo_path. Description confirms the parameter's role ('查询指定仓库') but adds no new meaning beyond the schema. Baseline score of 3 is appropriate.

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?

Description clearly states the verb (查询/检查), resource (仓库索引状态), and expected output (status field with values 'success' and 'progress'). It distinguishes this tool from siblings like ask_repo_ai or discover_repositories by focusing on index status.

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?

Description implies usage for checking if a repository is indexed, but does not provide explicit guidance on when to use vs. alternatives, or when not to use. No exclusions or prerequisites mentioned.

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

Install Server

Other Tools

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/ejfkdev/zread-mcp'

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