Add Field descriptions #6
Conversation
sylwia-budzynska
requested review from
JarLob,
kevinbackhouse,
m-y-mo and
p-
as code owners
There was a problem hiding this comment.
Pull request overview
This PR systematically adds Field descriptions to the owner and repo parameters across all MCP tool functions in the repository context module. Previously, these parameters lacked descriptions while other parameters in the same functions had them, creating inconsistency in the API documentation.
- Adds Field descriptions for
ownerparameter: "The owner of the GitHub repository" - Adds Field descriptions for
repoparameter: "The name of the GitHub repository" - Updates 25 MCP tool functions to include these descriptions
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @mcp.tool() | ||
| def get_entry_points(owner: str, repo: str, location: str = Field(description="The directory of the component")): | ||
| def get_entry_points(owner: str = Field(description="The owner of the GitHub repository"), | ||
| repo: str = Field(description="The name of the GitHub repository"), location: str = Field(description="The directory of the component")): |
There was a problem hiding this comment.
The location parameter should be on a new line for consistency with the formatting pattern used throughout the rest of the file. Each parameter should be on its own line when a function signature spans multiple lines.
| repo: str = Field(description="The name of the GitHub repository"), location: str = Field(description="The directory of the component")): | |
| repo: str = Field(description="The name of the GitHub repository"), | |
| location: str = Field(description="The directory of the component")): |
|
|
||
| @mcp.tool() | ||
| def get_component_potential_results(owner: str, repo: str, component_id: int): | ||
| def get_component_potential_results(owner: str = Field(description="The owner of the GitHub repository"), |
There was a problem hiding this comment.
Missing space after the comma at the end of this line. For consistency with the formatting pattern used throughout the file, there should be a space after the comma before the line continuation.
| def get_component_potential_results(owner: str = Field(description="The owner of the GitHub repository"), | |
| def get_component_potential_results(owner: str = Field(description="The owner of the GitHub repository"), |
No description provided.