github_sync

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

No annotations are provided, so the description must fully disclose behavioral traits. It mentions that data is synced into Lore as memories, but does not clarify whether the tool is idempotent, if it overwrites existing memories, or any side effects. It also lacks information about authentication scopes, rate limits, or error behavior. This is insufficient for a tool with no annotation support.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise at two sentences, but it lacks structure such as parameter breakdown or return value info. The second sentence embeds the usage guideline effectively, but the overall brevity sacrifices necessary details.

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

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

Given the tool has four parameters with no schema descriptions and no examples, the description is far from complete. It does not explain the output schema, even though one exists, and provides no guidance on how to construct valid parameter values. Essential details for an ingestion tool are missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema has 0% description coverage for parameters; the description does not explain any of the four parameters (repo, types, since, project). It only mentions the types of data (PRs, issues, etc.) in the tool purpose, but does not link them to the 'types' parameter or describe the format of 'since' or 'project'. This leaves the agent clueless about how to fill in the parameters correctly.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool syncs GitHub repository data (PRs, issues, commits, releases) into Lore as memories, using a specific verb ('sync') and resource ('GitHub repository data'). It distinguishes itself from sibling tools, which are mostly about memory management and recall, not external data ingestion.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description includes an explicit usage context ('USE THIS WHEN: you want to ingest tribal knowledge from a GitHub repo so it's searchable.') and states a prerequisite ('Requires the `gh` CLI to be installed and authenticated.'). However, it does not mention when not to use it or provide alternative tools for different scenarios.

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