Skip to main content
Glama

Analyze open docs issues

analyze_open_issues

Search open GitHub issues for documentation, README, or quickstart gaps to identify unresolved docs problems and prioritize fixes.

Instructions

Search open GitHub issues related to docs, README, or quickstart gaps.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "github": "<github>"
    },
    "name": "analyze_open_issues"
  }
}

Input Schema

NameRequiredDescriptionDefault
githubYesGitHub repo as owner/repo or https://github.com/owner/repo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

B3.1/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden, and it discloses very little: 'Search' implies read-only, but nothing is said about authentication, rate limits, result volume, pagination, or whether the call is expensive. For a tool whose name promises 'analyze', the absence of any statement about what the operation actually does behaviorally is a real gap.

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?

It is a single front-loaded sentence with no filler, and the scope qualifier arrives immediately after the verb. The terseness borders on under-specification rather than padding, so it earns credit for structure while leaving the reader wanting one more sentence.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no annotations and no output schema, the description is the only source of behavioral detail, and it does not clarify whether the tool returns a raw issue list or a synthesized analysis despite the 'analyze' name. For a tool with one fully documented parameter this is close to adequate, but the search-versus-analyze ambiguity leaves an agent unable to predict the response.

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?

There is a single required parameter and schema description coverage is 100%, so the schema already fully documents the owner/repo format. The description adds no meaning beyond that — it never mentions the repository argument or how it influences the search scope, so the baseline of 3 applies.

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 gives a concrete verb ('Search') and resource ('open GitHub issues') scoped to a specific domain ('docs, README, or quickstart gaps'), so the agent knows exactly what it retrieves. It stops short of differentiating itself from siblings like run_full_audit or cross_check_snippets, and the 'search' wording sits slightly at odds with the 'analyze' name, which creates mild ambiguity about whether results are raw issues or an analysis.

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?

The scoping to docs/README/quickstart gaps implies the situation in which to call it, but there is no explicit when-to-use or when-not-to-use guidance and no named alternative among the siblings. An agent can infer intent but must guess whether this belongs before or instead of run_full_audit.

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