Self

Provides tool-assisted Self protocol integration, code generation, config reading, and debugging capabilities for privacy-preserving identity verification.

python

11

GitHub Stars

python

Language

4 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "selfxyz-self-mcp": {
      "command": "python",
      "args": [
        "/path/to/self-mcp/self-mcp/server.py"
      ],
      "env": {
        "PATH": "YOUR_PATH",
        "PYTHONPATH": "YOUR_PYTHONPATH"
      }
    }
  }
}

You can run and interact with the Self MCP Server to enable privacy-preserving identity verification in your apps. It provides core Self protocol tools, direct blockchain interactions through Tools.self.xyz, and Web3 read-only operations to help you build and test integrations safely.

How to use

To use the Self MCP Server, start it locally or connect to a remote MCP endpoint that implements the Self protocol. You will use an MCP client to request integration guidance, generate verification configurations, and debug verification flows. You can generate frontend components, backend verification handlers, or smart-contract bits, and you can read configuration data from the hub or configurations in your project.

How to install

Prerequisites: Python 3.8+ and Git. You may install the MCP server directly from a Git URL or set up a local development environment.

Option 1 Install from GitHub (Recommended) use this command to install the MCP server package as a Python package from its Git URL.

pip install git+https://github.com/selfxyz/self-mcp.git

Option 1 run

After installation, you start the MCP server using the provided CLI command.

self-mcp

Option 2 Local development setup

If you prefer a local development setup, follow these steps to clone, set up a virtual environment, and install dependencies.

git clone https://github.com/selfxyz/self-mcp.git
cd self-mcp

python -m venv venv

On macOS/Linux:

source venv/bin/activate

On Windows:

venv\Scripts\activate

pip install -e .

python server.py  # Should start without errors

Verification of installation

To verify the development setup, ensure the server starts without errors by running the server script.

python server.py

Available tools

explain_self_integration

Get integration guides for specific use cases like airdrop, age-verification, or humanity-check.

generate_verification_code

Generate code snippets for Self integration across frontend QR, backend verification, or smart contracts.

debug_verification_error

Diagnose and debug errors encountered during Self verification flows.

check_self_status

Query Self protocol network status and contracts for a given network.

generate_verification_config

Assemble a complete verification configuration based on given requirements.

explain_sdk_setup

Clarify backend SDK requirements for storage, user IDs, or attestation setup.

generate_eu_id_verification

Produce EU ID card verification code blocks for frontend, backend, or smart contracts.

generate_scope_hash

Create a deterministic scope hash from an address/URL and a seed.

generate_config_id

Create a blockchain-verified config ID from verification requirements.

read_hub_config

Read configuration data from the hub contract for a given config ID.

list_country_codes

List available country codes for verification configuration.

guide_to_tools

Generate a pre-filled link to tools.self.xyz with selected parameters.