MCSM API

English|Chinese Simplified

Documentation

📄 Docs: docs

💡 Example: example

Introduction

mcsmapi is an async Python SDK for MCSManager, built on httpx + pydantic.

• Fully async (sync/await)
• Typed models with IDE autocompletion
• Chainable operations on returned objects
• Supports sync with context manager

Installation

ash pip install mcsmapi

For the latest build: Actions

Supported Features

• Dashboard data (Overview)
• User management (User)
• Instance management (Instance)
• Daemon management (Daemon)
• File management (File)
• Image management (Image)
• Schedule task management (Schedule)
• Java runtime management (Java)
• Mod management (Mod)
• Panel & Daemon upgrade (Upgrade)

Supported MCSM Versions

Quick Example

`python import asyncio from mcsmapi import MCSMAPI

async def main(): mcsm = MCSMAPI("http://localhost:23333") await mcsm.login("admin", "password")

# Dashboard
data = await mcsm.overview.overview()
print(f"Panel version: {data.version}")

# List daemons
daemons = await mcsm.daemon.config()
for d in daemons:
    print(f"  {d.remarks} ({d.ip}:{d.port})")

# Search instances on a daemon
instances = await daemons[0].search_instances()
for inst in instances.data:
    print(f"  {inst.config.nickname} [{inst.status.name}]")

# Partial config update (only sends provided fields)
inst = instances.data[0]
await inst.updateConfig({"nickname": "My Server"})

# File operations via chaining
files = await inst.files(target=".")
for f in files.items[:5]:
    print(f"  {f.name}")

await mcsm.close()

asyncio.run(main()) `

See example/ for more usage patterns.

Contributing

Feel free to submit an Issue or Pull Request.

License

MIT License — see LICENSE.