Skip to content

Commit 574dc4d

Browse files
committed
docs: fix stale references, add cross-repo badges
- Fix plugin.json description: 20 -> 25 MCP tools - Remove stale 'planned for vX.X' language in 4 skills (review-analysis, price-history, pricing-strategy, multiplayer-networking) - Update steam-api-reference MCP tables to list all 25 tools (was 13) - Fix .cursorrules searchApps example (bad example was identical to good) - Add MCP Usage, Key References, Common Pitfalls, See Also to CONTRIBUTING.md skill section list - Fix README v0.9.0 release history row (20 tools, not 25) - Add npm version and downloads badges to README badge row and Companion section - Add npm link to docs/index.html footer Made-with: Cursor
1 parent eb9a281 commit 574dc4d

10 files changed

Lines changed: 54 additions & 18 deletions

File tree

.cursor-plugin/plugin.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "steam-cursor-plugin",
33
"displayName": "Steam Developer Tools",
44
"version": "0.9.0",
5-
"description": "Integrates Steam and Steamworks APIs for game developers and power users. 30 skills covering store data, multiplayer, cloud saves, leaderboards, input, inventory, social, profiles, comparisons, reviews, pricing, market research, wishlists, CI/CD, release checklists, steamcmd, community, store pages, pricing strategy, DLC, playtesting, bug reporting, anti-cheat, testing sandbox, and platform migration - plus 9 rules. Companion Steam MCP server provides 20 API tools.",
5+
"description": "Integrates Steam and Steamworks APIs for game developers and power users. 30 skills covering store data, multiplayer, cloud saves, leaderboards, input, inventory, social, profiles, comparisons, reviews, pricing, market research, wishlists, CI/CD, release checklists, steamcmd, community, store pages, pricing strategy, DLC, playtesting, bug reporting, anti-cheat, testing sandbox, and platform migration - plus 9 rules. Companion Steam MCP server provides 25 MCP tools.",
66
"author": {
77
"name": "TMHSDigital",
88
"url": "https://github.com/TMHSDigital"

.cursorrules

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,6 @@
2727
## MCP Tool Signatures
2828

2929
When referencing MCP tools in documentation, use the canonical parameter names from the skill files:
30-
- `steam_searchApps({ query })` not `{ query }`
30+
- `steam_searchApps({ query })` not `{ term }`
3131
- `steam_getWorkshopItem({ publishedfileid })` not `{ fileid }`
3232
- `steam_getLeaderboardEntries({ appid, leaderboardid, rangestart?, rangeend? })` not `{ id, range }`

CONTRIBUTING.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,15 @@ rules/ # 9 rule files
5858
description: One-line description of what the skill does and when to use it.
5959
---
6060
```
61-
3. Structure the body with these sections:
61+
3. Structure the body with these sections (in order):
6262
- **Trigger** - when Cursor should load this skill
6363
- **Required Inputs** - what the user must provide
6464
- **Workflow** - step-by-step instructions for the agent
65+
- **Key References** - links to official Steamworks/Steam docs
6566
- **Example Interaction** - sample prompt and response
67+
- **MCP Usage** - table mapping workflow steps to MCP tools (required even for SDK-only skills)
68+
- **Common Pitfalls** - numbered list of mistakes to avoid
69+
- **See Also** - links to related skills
6670

6771
## Adding a Rule
6872

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
<a href="https://github.com/TMHSDigital/Steam-Cursor-Plugin/actions/workflows/validate.yml"><img src="https://img.shields.io/github/actions/workflow/status/TMHSDigital/Steam-Cursor-Plugin/validate.yml?label=CI" alt="CI"></a>
1313
<a href="LICENSE"><img src="https://img.shields.io/badge/license-CC--BY--NC--ND--4.0-blue.svg" alt="License: CC BY-NC-ND 4.0"></a>
1414
<a href="CHANGELOG.md"><img src="https://img.shields.io/badge/version-0.9.0-green.svg" alt="Version"></a>
15+
<a href="https://www.npmjs.com/package/@tmhs/steam-mcp"><img src="https://img.shields.io/npm/v/@tmhs/steam-mcp?label=MCP%20server" alt="npm version"></a>
16+
<a href="https://www.npmjs.com/package/@tmhs/steam-mcp"><img src="https://img.shields.io/npm/dw/@tmhs/steam-mcp?label=MCP%20downloads" alt="npm downloads"></a>
1517
<a href="https://github.com/TMHSDigital/Steam-Cursor-Plugin/stargazers"><img src="https://img.shields.io/github/stars/TMHSDigital/Steam-Cursor-Plugin?style=flat" alt="GitHub Stars"></a>
1618
<a href="https://github.com/TMHSDigital/Steam-Cursor-Plugin/commits/main"><img src="https://img.shields.io/github/last-commit/TMHSDigital/Steam-Cursor-Plugin" alt="Last Commit"></a>
1719
<a href="https://github.com/TMHSDigital/Steam-Cursor-Plugin"><img src="https://img.shields.io/badge/Cursor-Plugin-8B5CF6.svg" alt="Cursor Plugin"></a>
@@ -135,6 +137,8 @@ flowchart LR
135137

136138
## Companion: Steam MCP Server
137139

140+
[![npm version](https://img.shields.io/npm/v/@tmhs/steam-mcp)](https://www.npmjs.com/package/@tmhs/steam-mcp) [![npm downloads](https://img.shields.io/npm/dw/@tmhs/steam-mcp)](https://www.npmjs.com/package/@tmhs/steam-mcp) [![GitHub stars](https://img.shields.io/github/stars/TMHSDigital/Steam-MCP?style=flat)](https://github.com/TMHSDigital/Steam-MCP/stargazers)
141+
138142
The [Steam MCP Server](https://github.com/TMHSDigital/steam-mcp) provides live, structured API tools that Cursor can call directly — no shell commands needed.
139143

140144
<details open>
@@ -452,7 +456,7 @@ See [ROADMAP.md](ROADMAP.md) for the full themed release plan toward v1.0.0.
452456
| **v0.6.0** | Quality | Playtest setup, bug reporting, anti-cheat, save compat / network security / error handling rules | Done |
453457
| **v0.7.0** | Full Power | Testing sandbox, 6 MCP write tools (lobbies, workshop, achievements, leaderboards, inventory) | Done |
454458
| **v0.8.0** | Polish | Migration guide, common pitfalls across all 30 skills | Done |
455-
| **v0.9.0** | Complete | 4 new MCP read tools (reviews, pricing, regional) — 25 MCP tools total | **Current** |
459+
| **v0.9.0** | Complete | 4 new MCP read tools (reviews, pricing, regional) — 20 MCP tools at release | **Current** |
456460
| v1.0.0 | Stable | Production release: 30 skills, 9 rules, 25 MCP tools | Planned |
457461

458462
</details>

docs/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -437,6 +437,7 @@ <h3>Add MCP server <span style="color:var(--text-muted);font-weight:400;font-siz
437437
<div class="footer-links">
438438
<a href="https://github.com/TMHSDigital/Steam-Cursor-Plugin">GitHub</a>
439439
<a href="https://github.com/TMHSDigital/steam-mcp">MCP Server</a>
440+
<a href="https://www.npmjs.com/package/@tmhs/steam-mcp">npm</a>
440441
<a href="https://github.com/TMHSDigital/Steam-Cursor-Plugin/blob/main/CHANGELOG.md">Changelog</a>
441442
<a href="https://github.com/TMHSDigital/Steam-Cursor-Plugin/blob/main/CONTRIBUTING.md">Contributing</a>
442443
<a href="https://github.com/TMHSDigital/Steam-Cursor-Plugin/blob/main/LICENSE">License</a>

skills/steam-api-reference/SKILL.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,9 @@ Users should store their API key in an environment variable (`STEAM_API_KEY`) an
101101

102102
The [Steam MCP server](https://github.com/TMHSDigital/steam-mcp) provides 25 tools that call Steam APIs directly, eliminating the need for manual `curl` commands for common operations.
103103

104-
### Available MCP Tools
104+
### Available MCP Tools (25)
105105

106-
**No API key required:**
106+
**No API key required (10 tools):**
107107

108108
| Tool | Description |
109109
|------|-------------|
@@ -112,9 +112,13 @@ The [Steam MCP server](https://github.com/TMHSDigital/steam-mcp) provides 25 too
112112
| `steam_getPlayerCount({ appid })` | Current concurrent player count |
113113
| `steam_getAchievementStats({ appid })` | Global achievement unlock percentages |
114114
| `steam_getWorkshopItem({ publishedfileid })` | Workshop item details (title, tags, subscribers) |
115+
| `steam_getReviews({ appid, filter?, language?, review_type?, purchase_type? })` | User reviews with filters and pagination |
116+
| `steam_getPriceOverview({ appids, cc })` | Batch price check for multiple apps in a region |
117+
| `steam_getAppReviewSummary({ appid })` | Review score, totals, and positive percentage |
118+
| `steam_getRegionalPricing({ appid, countries })` | Pricing breakdown across multiple countries |
115119
| `steam_getNewsForApp({ appid, count?, maxlength? })` | Recent news and announcements |
116120

117-
**Requires `STEAM_API_KEY` environment variable:**
121+
**Requires `STEAM_API_KEY` environment variable (7 tools):**
118122

119123
| Tool | Description |
120124
|------|-------------|
@@ -126,6 +130,19 @@ The [Steam MCP server](https://github.com/TMHSDigital/steam-mcp) provides 25 too
126130
| `steam_getSchemaForGame({ appid })` | Achievement/stat schema with display names, descriptions, icons |
127131
| `steam_getPlayerAchievements({ steamid, appid })` | Per-player achievement unlock status and timestamps |
128132

133+
**SDK guidance / publisher key (8 tools):**
134+
135+
| Tool | Auth | Description |
136+
|------|------|-------------|
137+
| `steam_createLobby({ type, max_members, metadata })` | SDK guide | ISteamMatchmaking lobby creation code examples |
138+
| `steam_uploadWorkshopItem({ appid, title, ... })` | SDK guide | ISteamUGC Workshop upload code examples |
139+
| `steam_updateWorkshopItem({ publishedfileid, ... })` | Publisher key | Update Workshop item metadata via partner API |
140+
| `steam_setAchievement({ steamid, appid, achievement })` | Publisher key | Unlock an achievement (dev/test) |
141+
| `steam_clearAchievement({ steamid, appid, achievement })` | Publisher key | Re-lock an achievement (dev/test) |
142+
| `steam_uploadLeaderboardScore({ appid, leaderboardid, ... })` | Publisher key | Upload leaderboard scores |
143+
| `steam_grantInventoryItem({ appid, steamid, itemdefid })` | Publisher key | Grant inventory items |
144+
| `steam_getLeaderboardsForGame({ appid })` | Publisher key | List all leaderboards with numeric IDs |
145+
129146
When an MCP tool exists for a given endpoint, prefer it over raw `curl` calls. For endpoints not covered by MCP tools (user stats, microtransactions), continue using the Web API directly.
130147

131148
The Steamworks SDK documentation and example generation logic remain the same regardless of MCP availability.

skills/steam-multiplayer-networking/SKILL.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,9 +138,15 @@ Steam does not provide built-in Elo/MMR. Recommended pattern:
138138
139139
## MCP Usage
140140
141-
Multiplayer networking uses in-process Steamworks SDK APIs (`ISteamMatchmaking`, `ISteamNetworkingSockets`, `ISteamGameServer`) with no Web API equivalents for lobby creation, P2P connections, or dedicated server management. This skill remains documentation-only regardless of whether the [Steam MCP server](https://github.com/TMHSDigital/steam-mcp) is available.
141+
Multiplayer networking uses in-process Steamworks SDK APIs (`ISteamMatchmaking`, `ISteamNetworkingSockets`, `ISteamGameServer`) with no Web API equivalents for P2P connections or dedicated server management.
142142
143-
Write-operation MCP tools for lobby management are planned for v0.7.0.
143+
| Step | MCP Tool | Auth | Purpose |
144+
|------|----------|------|---------|
145+
| Lobby code examples | `steam_createLobby({ type, max_members, metadata })` | SDK guide | Get C++/C#/GDScript code for lobby creation |
146+
147+
The `steam_createLobby` tool returns SDK code examples and documentation, not an HTTP API call. The actual lobby creation happens in-process via the Steamworks SDK.
148+
149+
If the MCP server is not available, use the SDK code examples in the Workflow section above.
144150
145151
## Common Pitfalls
146152

skills/steam-price-history/SKILL.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,9 @@ If the user is pricing their own game, provide benchmarks:
148148
| Multi-region pricing | `steam_getPriceOverview({ appids, cc })` | None | Multiple `curl` calls |
149149
| Resolve name | `steam_searchApps({ query })` | None | Manual search |
150150

151-
The `steam_getPriceOverview` tool is planned for v0.3.0 of the MCP server. Until available, use `steam_getAppDetails({ appid })` with the `&cc=` parameter for each region.
151+
For regional pricing across multiple countries in a single call, use `steam_getRegionalPricing({ appid, countries })`.
152+
153+
If the MCP server is not available, fall back to the `curl`-based workflow above.
152154

153155
## Common Pitfalls
154156

skills/steam-pricing-strategy/SKILL.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,9 +175,10 @@ Bundles dynamically adjust price — players who already own some items pay less
175175
|------|----------|------|---------|
176176
| Competitor pricing | `steam_getAppDetails({ appid })` | None | Check competitor prices and regional variants |
177177
| Search competitors | `steam_searchApps({ query })` | None | Find competing games for price benchmarking |
178-
| Regional pricing | `steam_getPriceOverview({ appids, cc })` | None | Batch price check (planned MCP tool) |
178+
| Regional pricing | `steam_getPriceOverview({ appids, cc })` | None | Batch price check for multiple apps |
179+
| Regional breakdown | `steam_getRegionalPricing({ appid, countries })` | None | Pricing across multiple countries |
179180

180-
The `steam_getPriceOverview` tool is planned for the MCP server. Until available, use `steam_getAppDetails` with `&cc=` parameter per region.
181+
If the MCP server is not available, fall back to `steam_getAppDetails` with `&cc=` parameter per region.
181182

182183
## Common Pitfalls
183184

skills/steam-review-analysis/SKILL.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Use this skill when the user:
2323

2424
## Workflow
2525

26-
> **Preferred:** If the [Steam MCP server](https://github.com/TMHSDigital/steam-mcp) is available and includes `steam_getReviews()`, use it instead of the `curl` commands below. See [MCP Usage](#mcp-usage).
26+
> **Preferred:** If the [Steam MCP server](https://github.com/TMHSDigital/steam-mcp) is available, use `steam_getReviews()` instead of the `curl` commands below. See [MCP Usage](#mcp-usage).
2727
2828
### 1. Resolve the App ID
2929

@@ -128,15 +128,16 @@ Present a structured breakdown:
128128

129129
## MCP Usage
130130

131-
When the [Steam MCP server](https://github.com/TMHSDigital/steam-mcp) is configured and includes the review tool:
131+
When the [Steam MCP server](https://github.com/TMHSDigital/steam-mcp) is configured:
132132

133133
| Step | MCP Tool | Auth | Replaces |
134134
|------|----------|------|----------|
135-
| Fetch reviews | `steam_getReviews({ appid, filter?, language?, count? })` | None | `curl` to `/appreviews/` |
135+
| Fetch reviews | `steam_getReviews({ appid, filter?, language?, review_type?, purchase_type? })` | None | `curl` to `/appreviews/` |
136+
| Review summary | `steam_getAppReviewSummary({ appid })` | None | `curl` for score/totals only |
137+
| Resolve name | `steam_searchApps({ query })` | None | Manual search |
138+
| Get store context | `steam_getAppDetails({ appid })` | None | `curl` to `appdetails` |
136139

137-
The `steam_getReviews` tool is planned for v0.3.0 of the MCP server. Until available, use the `curl`-based workflow above.
138-
139-
Resolve game names with `steam_searchApps({ query })` and get store context with `steam_getAppDetails({ appid })` (both already available).
140+
If the MCP server is not available, fall back to the `curl`-based workflow above.
140141

141142
## Common Pitfalls
142143

0 commit comments

Comments
 (0)