arcade-mcp/toolkits/github_api/arcade_github_api/wrapper_tools/GetGithubUserHovercardInfo.json

{
  "name": "GetGithubUserHovercardInfo",
  "fully_qualified_name": "GithubApi.GetGithubUserHovercardInfo@0.1.0",
  "description": "Retrieve detailed hovercard info for a GitHub user.\n\nFetches hovercard information about a specified GitHub user, offering insights related to their pull requests, issues, repositories, and organizations. Requires authentication through basic auth or OAuth with the `repo` scope. Enhanced details can be obtained by specifying `subject_type` and `subject_id` parameters.",
  "toolkit": {
    "name": "ArcadeGithubApi",
    "description": null,
    "version": "0.1.0"
  },
  "input": {
    "parameters": [
      {
        "name": "github_username",
        "required": true,
        "description": "The GitHub username for which to retrieve hovercard information.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The handle for the GitHub user account."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "username"
      },
      {
        "name": "additional_info_type",
        "required": false,
        "description": "Specifies the type of related information for the user's hovercard. Options: `organization`, `repository`, `issue`, `pull_request`. Required with `subject_id`.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": [
            "organization",
            "repository",
            "issue",
            "pull_request"
          ],
          "properties": null,
          "inner_properties": null,
          "description": "Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "subject_type"
      },
      {
        "name": "subject_identifier",
        "required": false,
        "description": "The ID corresponding to the specified `subject_type` (e.g., organization, repository). Required if `subject_type` is used.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "subject_id"
      }
    ]
  },
  "output": {
    "description": "Response from the API endpoint 'users/get-context-for-user'.",
    "available_modes": [
      "value",
      "error",
      "null"
    ],
    "value_schema": {
      "val_type": "json",
      "inner_val_type": null,
      "enum": null,
      "properties": null,
      "inner_properties": null,
      "description": null
    }
  },
  "requirements": {
    "authorization": {
      "provider_id": "arcade-github",
      "provider_type": "oauth2",
      "id": null,
      "oauth2": null
    },
    "secrets": [
      {
        "key": "GIT_SERVER_URL"
      }
    ],
    "metadata": null
  },
  "deprecation_message": null,
  "metadata": {
    "object_type": "api_wrapper_tool",
    "version": "1.1.0",
    "description": "Tools that enable LLMs to interact directly with the GitHub API."
  },
  "http_endpoint": {
    "metadata": {
      "object_type": "http_endpoint",
      "version": "1.2.0",
      "description": ""
    },
    "url": "{git_server_url}/api/v3/users/{username}/hovercard",
    "http_method": "GET",
    "headers": {},
    "parameters": [
      {
        "name": "subject_type",
        "tool_parameter_name": "additional_info_type",
        "description": "Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": [
            "organization",
            "repository",
            "issue",
            "pull_request"
          ],
          "properties": null,
          "inner_properties": null,
          "description": "Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`."
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "subject_id",
        "tool_parameter_name": "subject_identifier",
        "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`."
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "username",
        "tool_parameter_name": "github_username",
        "description": "The handle for the GitHub user account.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The handle for the GitHub user account."
        },
        "accepted_as": "path",
        "required": true,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      }
    ],
    "documentation_urls": [],
    "secrets": [
      {
        "arcade_key": "GIT_SERVER_URL",
        "parameter_name": "git_server_url",
        "accepted_as": "path",
        "formatted_value": null,
        "description": "",
        "is_auth_token": false
      },
      {
        "arcade_key": "auth_token",
        "parameter_name": "Authorization",
        "accepted_as": "header",
        "formatted_value": "Bearer {authorization}",
        "description": "The OAuth token to use for authentication.",
        "is_auth_token": true
      }
    ],
    "request_body_spec": null,
    "use_request_body_schema_mode": false,
    "validate_request_body_schema": false
  }
}