Open Context Protocol is live! 🚀 Read the launch post
usersListFollowersForUser

usersListFollowersForUser

List followers of a user

Details

  • Method: GET
  • Path: /users/{username}/followers
  • Operation ID: users/list-followers-for-user

Parameters

{
  "username": {
    "description": "The handle for the GitHub user account.",
    "required": true,
    "location": "path",
    "type": "string"
  },
  "per_page": {
    "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
    "required": false,
    "location": "query",
    "type": "integer"
  },
  "page": {
    "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
    "required": false,
    "location": "query",
    "type": "integer"
  }
}

Response Schema

{
  "type": "array",
  "items": {
    "title": "Simple User",
    "description": "A GitHub user.",
    "type": "object",
    "properties": {
      "name": {
        "nullable": true,
        "type": "string"
      },
      "email": {
        "nullable": true,
        "type": "string"
      },
      "login": {
        "type": "string",
        "example": "octocat"
      },
      "id": {
        "type": "integer",
        "format": "int64",
        "example": 1
      },
      "node_id": {
        "type": "string",
        "example": "MDQ6VXNlcjE="
      },
      "avatar_url": {
        "type": "string",
        "format": "uri",
        "example": "https://github.com/images/error/octocat_happy.gif"
      },
      "gravatar_id": {
        "type": "string",
        "example": "41d064eb2195891e12d0413f63227ea7",
        "nullable": true
      },
      "url": {
        "type": "string",
        "format": "uri",
        "example": "https://api.github.com/users/octocat"
      },
      "html_url": {
        "type": "string",
        "format": "uri",
        "example": "https://github.com/octocat"
      },
      "followers_url": {
        "type": "string",
        "format": "uri",
        "example": "https://api.github.com/users/octocat/followers"
      },
      "following_url": {
        "type": "string",
        "example": "https://api.github.com/users/octocat/following{/other_user}"
      },
      "gists_url": {
        "type": "string",
        "example": "https://api.github.com/users/octocat/gists{/gist_id}"
      },
      "starred_url": {
        "type": "string",
        "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
      },
      "subscriptions_url": {
        "type": "string",
        "format": "uri",
        "example": "https://api.github.com/users/octocat/subscriptions"
      },
      "organizations_url": {
        "type": "string",
        "format": "uri",
        "example": "https://api.github.com/users/octocat/orgs"
      },
      "repos_url": {
        "type": "string",
        "format": "uri",
        "example": "https://api.github.com/users/octocat/repos"
      },
      "events_url": {
        "type": "string",
        "example": "https://api.github.com/users/octocat/events{/privacy}"
      },
      "received_events_url": {
        "type": "string",
        "format": "uri",
        "example": "https://api.github.com/users/octocat/received_events"
      },
      "type": {
        "type": "string",
        "example": "User"
      },
      "site_admin": {
        "type": "boolean"
      },
      "starred_at": {
        "type": "string",
        "example": "\"2020-07-09T00:17:55Z\""
      },
      "user_view_type": {
        "type": "string",
        "example": "public"
      }
    },
    "required": [
      "avatar_url",
      "events_url",
      "followers_url",
      "following_url",
      "gists_url",
      "gravatar_id",
      "html_url",
      "id",
      "node_id",
      "login",
      "organizations_url",
      "received_events_url",
      "repos_url",
      "site_admin",
      "starred_url",
      "subscriptions_url",
      "type",
      "url"
    ]
  }
}

Usage

from ocp_agent import OCPAgent

agent = OCPAgent()
await agent.register_api('github')

# Call this tool
result = await agent.call_tool('usersListFollowersForUser', {
    # Add required parameters here
})