English Français العربية

osu! MCP

السجل الرسمي البحث والويب

MCP server exposing the osu! API v2: player stats, scores, beatmap search, rankings.

الشيفرة المصدرية التوثيق

التثبيت

أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: ‏.cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).

PYPI package osu-mcp
Claude Code 
claude mcp add osu-mcp -e 'OSU_CLIENT_ID=<OSU_CLIENT_ID>' -e 'OSU_CLIENT_SECRET=<your osu_client_secret>' -- uvx osu-mcp==0.1.4
إعداد JSON (Claude Desktop وCursor وVS Code) 
{
    "mcpServers": {
        "osu-mcp": {
            "command": "uvx",
            "args": [
                "osu-mcp==0.1.4"
            ],
            "env": {
                "OSU_CLIENT_ID": "<OSU_CLIENT_ID>",
                "OSU_CLIENT_SECRET": "<your osu_client_secret>"
            }
        }
    }
}

متغيرات البيئة

  • OSU_CLIENT_ID إلزامي Numeric Client ID from your osu! OAuth application (https://osu.ppy.sh/home/account/edit).
  • OSU_CLIENT_SECRET إلزامي سري Client Secret from the same osu! OAuth application.

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

المحتويات
  1. osu-mcp
  2. Quickstart
  3. Available tools (12)
  4. Examples
  5. Development
  6. License

osu-mcp

osu-mcp is a Model Context Protocol (MCP) server that exposes the osu! API v2 as tools for Claude Desktop and other MCP clients. Ask Claude about your osu! profile, compare players, search beatmaps, browse rankings — all in natural language.

Quickstart

1. Install
uv tool install osu-mcp
# or
pip install osu-mcp
2. Get osu! API credentials
  1. Go to https://osu.ppy.sh/home/account/edit
  2. Scroll to OAuth, click New OAuth Application
  3. Name: anything (e.g., "Claude Desktop"); Callback URL: leave blank.
  4. Copy the Client ID and Client Secret.
3. Configure credentials

Option A — environment variables (recommended):

export OSU_CLIENT_ID=12345
export OSU_CLIENT_SECRET=your-client-secret

Option B — config file at ~/.config/osu-mcp/config.toml (Linux/Mac) or %APPDATA%\osu-mcp\config.toml (Windows):

client_id = 12345
client_secret = "your-client-secret"
4. Wire up Claude Desktop

Add to claude_desktop_config.json:

{
  "mcpServers": {
    "osu": {
      "command": "uvx",
      "args": ["osu-mcp"],
      "env": {
        "OSU_CLIENT_ID": "12345",
        "OSU_CLIENT_SECRET": "your-client-secret"
      }
    }
  }
}

Restart Claude Desktop. You should see "osu" in the MCP servers list.

Available tools (12)

ToolDescription
get_user_summaryProfile + stats; optionally embed recent/best/firsts scores
compare_usersSide-by-side comparison of 2-5 users
get_user_scoresList a user's best/recent/firsts scores
get_score_detailsFull attributes of a specific score
search_beatmapsSearch beatmapsets with filters (mode, status, difficulty, length, BPM)
get_beatmap_detailsFull attributes of a beatmap (AR/OD/CS/HP, BPM, max combo)
get_beatmap_scoresTop scores on a beatmap, filterable by mods
get_beatmapsetFull beatmapset with all difficulties
get_rankingspp/score/charts rankings, global or by country
get_country_topTop N players of a country in pp ranking
get_news_postsRecent osu! news posts
get_seasonal_backgroundsActive seasonal backgrounds

Full reference: docs/tools.md.

Examples

In Claude Desktop, try:

"Show me peppy's osu! stats"

"Compare Cookiezi and WhiteCat on accuracy and pp"

"What are the top 10 osu! players from Ecuador?"

"Find me some 200 BPM streamy ranked maps"

Development

git clone https://github.com/Osyanne/osu-mcp.git
cd osu-mcp
uv sync
uv run pytest                      # unit + smoke
uv run pytest -m integration       # integration (needs real creds)
uv run ruff check .
uv run mypy --strict src/

License

MIT — see LICENSE.

الأسئلة الشائعة

ما هو osu! MCP؟

MCP server exposing the osu! API v2: player stats, scores, beatmap search, rankings.

كيف أثبّت osu! MCP؟

يعمل على جهازك. في Claude Code: claude mcp add osu-mcp -e 'OSU_CLIENT_ID=<OSU_CLIENT_ID>' -e 'OSU_CLIENT_SECRET=<your osu_client_secret>' -- uvx osu-mcp==0.1.4. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.

هل يحتاج osu! MCP إلى مفتاح API؟

نعم. يتطلب OSU_CLIENT_ID, OSU_CLIENT_SECRET، وتضبطها في إعداداته.

هل osu! MCP مفتوح المصدر؟

نعم. شيفرته متاحة على GitHub بترخيص MIT.

من يصون osu! MCP؟

ينشره Osyanne. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.