Skip to content

Commit bb6d97e

Browse files
committed
prep for npm publish: add files/prepublishOnly, document leaderboard partner API limitation, fix related section
Made-with: Cursor
1 parent 3481ca9 commit bb6d97e

3 files changed

Lines changed: 12 additions & 6 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Tools that don't need a key work out of the box with zero configuration.
4646

4747
Add the Steam MCP server to your Cursor MCP settings (`.cursor/mcp.json` in your project or global settings):
4848

49-
**Via npx (recommended once published to npm):**
49+
**Via npx (recommended):**
5050

5151
```json
5252
{
@@ -103,7 +103,7 @@ These require `STEAM_API_KEY` to be set:
103103
| `steam.getPlayerSummary` | Player profile: name, avatar, online status |
104104
| `steam.getOwnedGames` | Game library with playtime data |
105105
| `steam.queryWorkshop` | Search/browse Workshop items with filters |
106-
| `steam.getLeaderboardEntries` | Leaderboard scores and rankings |
106+
| `steam.getLeaderboardEntries` | Leaderboard scores and rankings (publisher API key + IP allowlist required) |
107107
| `steam.resolveVanityURL` | Convert vanity URL to 64-bit Steam ID |
108108

109109
## Planned Tools
@@ -141,7 +141,7 @@ These require `STEAM_API_KEY` to be set:
141141
| `ISteamUser/ResolveVanityURL/v1` | API key |
142142
| `ISteamRemoteStorage/GetPublishedFileDetails/v1` | None |
143143
| `IPublishedFileService/QueryFiles/v1` | API key |
144-
| `ISteamLeaderboards/GetLeaderboardEntries/v1` | API key |
144+
| `ISteamLeaderboards/GetLeaderboardEntries/v1` | Publisher key + IP allowlist |
145145

146146
## Development
147147

@@ -155,7 +155,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for how to add new tools and submit PRs.
155155

156156
## Related
157157

158-
- [Steam Developer Tools](https://github.com/TMHSDigital/Steam-Cursor-Plugin) - Cursor IDE plugin with 14 skills and 3 rules for Steam/Steamworks development
158+
- [Steam Developer Tools](https://github.com/TMHSDigital/Steam-Cursor-Plugin) - Cursor IDE plugin with 14 skills and 4 rules for Steam/Steamworks development
159159

160160
## License
161161

package.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,16 @@
77
"bin": {
88
"steam-mcp": "dist/index.js"
99
},
10+
"files": [
11+
"dist",
12+
"README.md",
13+
"LICENSE"
14+
],
1015
"scripts": {
1116
"build": "tsc",
1217
"dev": "tsx watch src/index.ts",
13-
"start": "node dist/index.js"
18+
"start": "node dist/index.js",
19+
"prepublishOnly": "npm run build"
1420
},
1521
"author": "TMHSDigital",
1622
"license": "CC-BY-NC-ND-4.0",

src/tools/getLeaderboardEntries.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ const inputSchema = {
4848
export function register(server: McpServer): void {
4949
server.tool(
5050
"steam.getLeaderboardEntries",
51-
"Get leaderboard scores and rankings for a Steam app. Supports global, around-user, and friends-only views. Requires STEAM_API_KEY.",
51+
"Get leaderboard scores and rankings for a Steam app. Uses the partner API (partner.steam-api.com) which requires a publisher API key with server IP allowlisted in Steamworks. Supports global, around-user, and friends-only views.",
5252
inputSchema,
5353
async ({
5454
appid,

0 commit comments

Comments
 (0)