arcade-mcp/toolkits/github/arcade_github/tools/issues.py
Nate Barbettini 036ad54ac6
Remove arcade.core from all examples (#121)
This PR ensures that `arcade.core` does not show up anywhere in "user
space". This is crucial for helping developers understand what objects
are safe to use, and helps maintain a good developer experience.

Specific changes:
- `ToolAuthorizationContext` and `ToolContext` are now visible via
`arcade.sdk`
- `ToolCatalog` is now visible via `arcade.sdk`
- `Toolkit` is now visible via `arcade.sdk`
- `config` is now visible via `arcade.sdk.config`
2024-10-24 17:08:04 -07:00

136 lines
5.3 KiB
Python

import json
from typing import Annotated, Optional
import httpx
from arcade.sdk import ToolContext, tool
from arcade.sdk.auth import GitHub
from arcade_github.tools.utils import (
get_github_json_headers,
get_url,
handle_github_response,
remove_none_values,
)
# Implements https://docs.github.com/en/rest/issues/issues?apiVersion=2022-11-28#create-an-issue
# Example `arcade chat` usage: "create an issue in the <REPO> repo owned by <OWNER> titled 'Found a bug' with the body 'I'm having a problem with this.' Assign it to <USER> and label it 'bug'"
@tool(requires_auth=GitHub())
async def create_issue(
context: ToolContext,
owner: Annotated[str, "The account owner of the repository. The name is not case sensitive."],
repo: Annotated[
str,
"The name of the repository without the .git extension. The name is not case sensitive.",
],
title: Annotated[str, "The title of the issue."],
body: Annotated[Optional[str], "The contents of the issue."] = None,
assignees: Annotated[Optional[list[str]], "Logins for Users to assign to this issue."] = None,
milestone: Annotated[
Optional[int], "The number of the milestone to associate this issue with."
] = None,
labels: Annotated[Optional[list[str]], "Labels to associate with this issue."] = None,
include_extra_data: Annotated[
bool,
"If true, return all the data available about the pull requests. This is a large payload and may impact performance - use with caution.",
] = False,
) -> Annotated[
str,
"A JSON string containing the created issue's details, including id, url, title, body, state, html_url, creation and update timestamps, user, assignees, and labels. If include_extra_data is True, returns all available data about the issue.",
]:
"""
Create an issue in a GitHub repository.
Example:
```
create_issue(owner="octocat", repo="Hello-World", title="Found a bug", body="I'm having a problem with this.", assignees=["octocat"], milestone=1, labels=["bug"])
```
"""
url = get_url("repo_issues", owner=owner, repo=repo)
data = {
"title": title,
"body": body,
"labels": labels,
"milestone": milestone,
"assignees": assignees,
}
data = remove_none_values(data)
headers = get_github_json_headers(context.authorization.token)
async with httpx.AsyncClient() as client:
response = await client.post(url, headers=headers, json=data)
handle_github_response(response, url)
issue_data = response.json()
if include_extra_data:
return json.dumps(issue_data)
important_info = {
"id": issue_data.get("id"),
"url": issue_data.get("url"),
"title": issue_data.get("title"),
"body": issue_data.get("body"),
"state": issue_data.get("state"),
"html_url": issue_data.get("html_url"),
"created_at": issue_data.get("created_at"),
"updated_at": issue_data.get("updated_at"),
"user": issue_data.get("user", {}).get("login"),
"assignees": [assignee.get("login") for assignee in issue_data.get("assignees", [])],
"labels": [label.get("name") for label in issue_data.get("labels", [])],
}
return json.dumps(important_info)
# Implements https://docs.github.com/en/rest/issues/comments?apiVersion=2022-11-28#create-an-issue-comment
# Example `arcade chat` usage: "create a comment in the vscode repo owned by microsoft for issue 1347 that says 'Me too'"
@tool(requires_auth=GitHub())
async def create_issue_comment(
context: ToolContext,
owner: Annotated[str, "The account owner of the repository. The name is not case sensitive."],
repo: Annotated[
str,
"The name of the repository without the .git extension. The name is not case sensitive.",
],
issue_number: Annotated[int, "The number that identifies the issue."],
body: Annotated[str, "The contents of the comment."],
include_extra_data: Annotated[
bool,
"If true, return all the data available about the pull requests. This is a large payload and may impact performance - use with caution.",
] = False,
) -> Annotated[
str,
"A JSON string containing the created comment's details, including id, url, body, user, and creation and update timestamps. If include_extra_data is True, returns all available data about the comment.",
]:
"""
Create a comment on an issue in a GitHub repository.
Example:
```
create_issue_comment(owner="octocat", repo="Hello-World", issue_number=1347, body="Me too")
```
"""
url = get_url("repo_issue_comments", owner=owner, repo=repo, issue_number=issue_number)
data = {
"body": body,
}
headers = get_github_json_headers(context.authorization.token)
async with httpx.AsyncClient() as client:
response = await client.post(url, headers=headers, json=data)
handle_github_response(response, url)
comment_data = response.json()
if include_extra_data:
return json.dumps(comment_data)
important_info = {
"id": comment_data.get("id"),
"url": comment_data.get("url"),
"body": comment_data.get("body"),
"user": comment_data.get("user", {}).get("login"),
"created_at": comment_data.get("created_at"),
"updated_at": comment_data.get("updated_at"),
}
return json.dumps(important_info)