`users`

Pack: lichess · Endpoint: https://gateway.pipeworx.io/lichess/mcp

Bulk lookup of up to 300 users by username.

Parameters

Name	Type	Required	Description
`usernames`	array	yes	1-300 usernames.
`items`	string	no

Example call

Arguments

{
  "usernames": [
    "hikaru",
    "magnuschess",
    "penguingm"
  ]
}

curl

curl -X POST https://gateway.pipeworx.io/lichess/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"users","arguments":{"usernames":["hikaru","magnuschess","penguingm"]}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('users', {
  "usernames": [
    "hikaru",
    "magnuschess",
    "penguingm"
  ]
});

More examples

{
  "usernames": [
    "botvinnik"
  ]
}

Response shape

Always returns: items, count

Field	Type	Description
`items`	array
`count`	integer	Number of items returned.

Full JSON Schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "User ID"
          },
          "username": {
            "type": "string",
            "description": "Username"
          },
          "title": {
            "type": "string",
            "description": "Title"
          },
          "online": {
            "type": "boolean",
            "description": "Online status"
          },
          "perfs": {
            "type": "object",
            "description": "Performance ratings",
            "additionalProperties": {
              "type": "object"
            }
          }
        }
      }
    },
    "count": {
      "type": "integer",
      "description": "Number of items returned."
    }
  },
  "required": [
    "items",
    "count"
  ]
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "lichess": {
      "url": "https://gateway.pipeworx.io/lichess/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

users