mushroom-magic-campus-auth 0.1.0

Magic Campus auth provider for MushroomAgent server auth.

mushroom-magic-campus-auth

Magic Campus authentication provider for MushroomAgent server auth.

It validates an incoming token by calling Magic Campus:

GET /api/v1/accounts/getUserInfo
Authorization: Bearer <AccessToken>

Expected response:

{
  "code": 200,
  "msg": "ok",
  "data": {
    "userId": 123,
    "nickname": "Alice",
    "avatarUrl": "https://example.test/avatar.png",
    "phone": "13800000000",
    "email": "[e-mail]"
  }
}

Install For Local Development

From this directory:

pip install -e .

Or install it into the same Python environment that runs mushroom-agent.

After publishing to PyPI:

pip install mushroom-magic-campus-auth

MushroomAgent Config

Add this provider to ~/.mushroom_agent/config.yaml:

server:
  auth:
    providers:
      - type: import
        path: mushroom_magic_campus_auth:create_provider
        config:
          base_url: "https://magic-campus.example.com"
          timeout_seconds: 3

      # Optional fallback to existing MushroomAgent accesskeys.
      - type: accesskey

If you do not include type: accesskey, only Magic Campus tokens will be accepted.

Token Sources

MushroomAgent extracts token candidates from:

• Authorization: Bearer <token>
• query parameters: accesskey, token, auth_token
• cookie: mushroom_server_auth

This means the provider works for:

• HTTP API
• WebUI login
• /ws/v1/chat
• /ws/v1/node

Config Options

config:
  base_url: "https://magic-campus.example.com"       # required
  user_info_path: "/api/v1/accounts/getUserInfo"     # optional
  timeout_seconds: 3                                 # optional
  expected_code: 200                                 # optional
  issue_cookie: false                                # optional
  headers:                                           # optional extra headers
    X-App-Id: "mushroom-agent"

issue_cookie: true asks MushroomAgent to set the accepted token as the auth cookie after WebUI login.

Try With curl

curl -X POST "http://127.0.0.1:7860/i/chat/api/messages" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <MagicCampusAccessToken>" \
  -d '{"text":"hello"}'

Development

pip install -e ".[dev]"
pytest

Build And Publish To PyPI

Install build tools:

pip install -e ".[dev]"

Build source and wheel distributions:

python -m build

Validate package metadata:

twine check dist/*

Upload to TestPyPI first:

twine upload --repository testpypi dist/*

Upload to PyPI:

twine upload dist/*

Use a PyPI API token when prompted for the password. The username is usually __token__.