STS2-Agent

mcp
Guvenlik Denetimi
Gecti
Health Gecti
  • License — License: NOASSERTION
  • Description — Repository has a description
  • Active repo — Last push 0 days ago
  • Community trust — 173 GitHub stars
Code Gecti
  • Code scan — Scanned 12 files during light audit, no dangerous patterns found
Permissions Gecti
  • Permissions — No dangerous permissions requested
Purpose
This project is a mod and MCP server for Slay the Spire 2. It exposes live game state data and player actions through a local HTTP API, enabling AI clients to play the game directly via MCP integration.

Security Assessment
Overall Risk: Low. The tool is designed to operate entirely within your local environment. It binds exclusively to localhost (`127.0.0.1`), meaning it does not expose your game data to the broader internet. The code scan found no hardcoded secrets, dangerous permissions, or malicious patterns. The only code execution involves running provided shell scripts and `uv` commands to launch the local MCP server, which is standard behavior for this type of tool. No sensitive user data is accessed or transmitted.

Quality Assessment
The project appears highly maintained, with repository activity as recent as today. It has strong community trust evident from its 173 GitHub stars, which is impressive for a specific game mod. Documentation is thorough, offering multiple startup options, detailed changelogs, and clear integration guides. The only minor drawback is that its software license is marked as "NOASSERTION," meaning it lacks a formally defined open-source license, though this is a common and non-critical oversight for personal gaming projects.

Verdict
Safe to use.
SUMMARY

杀戮尖塔2的MOD,将杀戮尖塔2的游戏状态与操作暴露为本地 HTTP API 包装成 MCP Server,供支持 MCP 的AI客户端直接调用

README.md

STS2 AI Agent

https://github.com/user-attachments/assets/89353468-a299-4315-9516-e520bcbfbd4b

中文版说明请见 README.zh-CN.md.

STS2 AI Agent is a Slay the Spire 2 mod + MCP server bundle:

  • STS2AIAgent: exposes game state and actions through a local HTTP API
  • mcp_server: wraps that local API as an MCP server for AI clients

What's New In v0.5.4

This release adds:

  • run-time Ascension data in RunPayload via run.ascension and run.ascension_effects[]
  • compact agent-view Ascension visibility through agent_view.run.ascension
  • a fix for reward-screen potion discard exposure: discard_potion is no longer exposed on reward / card-reward screens
  • updated regression checks covering both Ascension payloads and reward-screen potion discard gating

Detailed MCP tool documentation lives in mcp_server/README.md. If you want an agent workflow on top of it, start with skills/sts2-mcp-player/SKILL.md.

Quick Start

1. Install The Mod

After downloading and extracting the release package, copy these files into your game's mods/ directory:

STS2AIAgent.dll
STS2AIAgent.pck
mod_id.json

The default Steam install path is usually:

C:\Program Files (x86)\Steam\steamapps\common\Slay the Spire 2

Your final layout should look like this:

Slay the Spire 2/
  mods/
    STS2AIAgent.dll
    STS2AIAgent.pck
    mod_id.json

2. Start The Game And Confirm The Mod Is Loaded

Launch the game normally so the mod can load with it.

Then open:

http://127.0.0.1:8080/health

If the endpoint responds, the mod is running.

3. Start The MCP Server

Prepare the environment first:

  1. Install Python 3.11+
  2. Install uv

Install uv on Windows:

powershell -ExecutionPolicy Bypass -c "irm https://astral.sh/uv/install.ps1 | iex"

On macOS:

brew install uv

Then start the default stdio MCP server.

Windows:

powershell -ExecutionPolicy Bypass -File ".\scripts\start-mcp-stdio.ps1"

macOS / Linux:

./scripts/start-mcp-stdio.sh

This is the recommended default. Most desktop AI clients prefer stdio MCP integration.

4. Connect Your MCP Client

If your client supports command-based MCP startup, point its working directory at mcp_server/ and use:

uv run sts2-mcp-server

If your client works better over HTTP, start the network server instead.

Windows:

powershell -ExecutionPolicy Bypass -File ".\scripts\start-mcp-network.ps1"

macOS / Linux:

./scripts/start-mcp-network.sh

Default MCP endpoint:

http://127.0.0.1:8765/mcp

What The Project Can Do

The current main branch provides a playable MCP integration for STS2, including:

  • reading live game state
  • listing currently legal actions
  • driving combat, rewards, shops, map routing, events, rest sites, and chests
  • reducing polling through SSE events
  • exposing MCP over stdio or HTTP
  • serving bundled game metadata for cards, relics, monsters, potions, and events
  • supporting layered planner / combat agent handoff flows

See mcp_server/README.md for the detailed tool surface.

FAQ

http://127.0.0.1:8080/health Does Not Open

Check these first:

  1. The game is actually running
  2. STS2AIAgent.dll, STS2AIAgent.pck, and mod_id.json are all inside the game's mods/ directory
  3. The files were not duplicated or renamed by the OS
  4. You copied them into the Steam game directory, not the repository directory

The MCP Server Starts But Cannot Read Game State

That usually means mcp_server is running, but the in-game mod is not connected. Confirm:

  1. The game is running
  2. http://127.0.0.1:8080/health is reachable
  3. The MCP server is still pointing at http://127.0.0.1:8080

Should I Enable Debug Actions?

Usually no.

Developer-only actions such as run_console_command are disabled by default and should stay disabled in normal use and releases.

Building From Source

If you are building from source instead of using a release package:

Windows:

powershell -ExecutionPolicy Bypass -File ".\scripts\build-mod.ps1" -Configuration Release

macOS / Linux:

./scripts/build-mod.sh --configuration Release

More complete environment, path-discovery, and validation notes are in build-and-env.md.

Repository Layout

  • STS2AIAgent/: game mod source
  • mcp_server/: MCP server source
  • scripts/: startup, build, and validation scripts
  • docs/: supporting documentation
  • skills/: companion skills

License

This project is licensed under the GNU Affero General Public License v3.0 only (AGPL-3.0-only).

Yorumlar (0)

Sonuc bulunamadi