Skip to main content
Glama

Create PR Summary

create_pr_summary
Read-onlyIdempotent

Generate a structured pull request summary including change overview, affected files, test coverage, risks, review checklist, and release notes draft from the PR diff and metadata.

Instructions

Generate a structured PR summary from the pull request diff and metadata.

The summary includes: change overview, affected files, test coverage signals, risks, review checklist, and release notes draft.

Args:

  • owner, repo: Repository coordinates.

  • pullNumber (number): The PR to summarise.

Returns: Markdown PR summary + structured metadata.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
repoNoGitHub repo. Falls back to GITHUB_REPO.
ownerNoGitHub owner. Falls back to GITHUB_OWNER.
pullNumberYesThe pull request number to summarise.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
risksYes
titleYes
authorYes
labelsYes
baseRefYes
commitsYes
headRefYes
isDraftYes
docsOnlyYes
hasTestsYes
pullNumberYes
totalFilesYes
filesTruncatedYes
totalAdditionsYes
totalDeletionsYes
Behavior5/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false; the description adds detailed content of the summary (change overview, risks, etc.), enhancing the agent's understanding of behavior.

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?

The description is concise and front-loaded with the core purpose. The listing of summary components is helpful, though the Args/Returns section could be streamlined.

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

Completeness5/5

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

Given the simple parameters (3, no nested objects), the output schema exists, and annotations are present, the description sufficiently covers all necessary context for invocation.

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 100%, and the description merely restates the schema fields (e.g., 'Repository coordinates') without adding new meaning beyond what the schema already provides.

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?

The description uses a specific verb ('Generate') and resource ('PR summary'), clearly distinguishing the tool from siblings like 'review_pr_against_standard' or 'release_readiness_check'.

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 description states what the tool does but provides no explicit guidance on when to use it vs alternatives, nor any exclusion criteria.

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/SakuraCianna/agentic-sdlc-mcp'

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