@xiawan-play/steam-tools-mcp 0.1.0

package/docs/configuration.md

@@ -0,0 +1,92 @@
+# 配置参数说明
+
+这份文档列出 `@xiawan-play/steam-tools-mcp` 当前支持的全部环境变量，并说明默认值、用途和推荐使用场景。
+
+README 里的 MCP 配置示例只保留最常用的 3 项：
+
+- `STEAM_WEB_API_KEY`
+- `STEAM_DEFAULT_STEAMID`
+- `STEAM_ENABLE_GENERATED_TOOLS`
+
+如果你需要更细的控制，再参考本文即可。
+
+## 常用参数
+
+| 变量名 | 默认值 | 作用 | 什么时候建议配置 |
+| --- | --- | --- | --- |
+| `STEAM_WEB_API_KEY` | 无 | 默认使用的 Steam Web API Key。很多资料、游戏库、成就、应用目录相关接口都依赖它。 | 只要你要查“我的资料 / 我的库 / 我的成就”这类信息，就建议配置。 |
+| `STEAM_DEFAULT_STEAMID` | 无 | 默认查询账号的 SteamID64。`steam_me_*` 工具和部分带 `steamid` / `steamids` 的工具会自动使用它。 | 你长期绑定自己的账号使用时，强烈建议配置。 |
+| `STEAM_ENABLE_GENERATED_TOOLS` | `false` | 是否开启辅助探索工具和完整的自动生成 Steam Web API 方法工具集。 | 你想把辅助调试工具和底层 Steam 方法工具一起暴露给 MCP 时再开启。 |
+
+## 高级可选参数
+
+| 变量名 | 默认值 | 作用 | 备注 |
+| --- | --- | --- | --- |
+| `STEAM_APP_LIST_CACHE_TTL_MS` | `21600000` | Steam 应用目录缓存时间，单位毫秒。 | 主要影响 `steam_search_apps` / `steam_resolve_app` 等应用目录相关工具。 |
+| `STEAM_REQUEST_TIMEOUT_MS` | `30000` | Steam API 请求超时时间，单位毫秒。 | 网络较慢、代理链路较长时可调大。 |
+
+## HTTP 模式参数
+
+这些参数只有在你显式启用 HTTP 传输时才有意义。
+
+| 变量名 | 默认值 | 作用 |
+| --- | --- | --- |
+| `MCP_TRANSPORT` | `stdio` | 传输方式，可选 `stdio` 或 `http`。 |
+| `HOST` | `127.0.0.1` | HTTP 模式监听地址。 |
+| `PORT` | `3000` | HTTP 模式监听端口。 |
+
+如果你是把这个服务配置到 Cursor、Claude Desktop、Cherry Studio 这类客户端里，本地直连场景通常都走 `stdio`，一般不用配置这 3 项。
+
+## 推荐配置档位
+
+### 1. 最小可用
+
+适合先跑起来或只查公开数据。
+
+```json
+{
+  "env": {}
+}
+```
+
+### 2. 个人常用
+
+适合长期绑定自己的 Steam 账号使用。
+
+```json
+{
+  "env": {
+    "STEAM_WEB_API_KEY": "YOUR_WEB_API_KEY",
+    "STEAM_DEFAULT_STEAMID": "YOUR_STEAM_ID64",
+    "STEAM_ENABLE_GENERATED_TOOLS": "false"
+  }
+}
+```
+
+### 3. 全量模式
+
+适合高级用户、调试或需要完整 Steam Web API 方法集时使用。
+
+```json
+{
+  "env": {
+    "STEAM_WEB_API_KEY": "YOUR_WEB_API_KEY",
+    "STEAM_DEFAULT_STEAMID": "YOUR_STEAM_ID64",
+    "STEAM_ENABLE_GENERATED_TOOLS": "true"
+  }
+}
+```
+
+## 使用建议
+
+- 如果你主要是自己用，推荐至少配置 `STEAM_WEB_API_KEY` 和 `STEAM_DEFAULT_STEAMID`。
+- 如果你只是想要“好用的 MCP 工具”，保持 `STEAM_ENABLE_GENERATED_TOOLS=false` 即可；此时默认只暴露高频工具和 `steam_me_*` 快捷工具。
+- 如果你需要方法目录检索、原始调试调用，或者想展开全量官方方法，再开启 `STEAM_ENABLE_GENERATED_TOOLS=true`。
+- 如果你的 MCP 客户端会直接拉起本地进程，通常不需要配置 `MCP_TRANSPORT`、`HOST`、`PORT`。
+- 如果你不需要调优缓存和网络行为，可以完全不配置 `STEAM_APP_LIST_CACHE_TTL_MS` 和 `STEAM_REQUEST_TIMEOUT_MS`。
+
+## 当前读取位置
+
+当前这些环境变量主要在源码中的 `src/server.ts` 里读取。
+
+如果后续新增参数，建议同步更新本文档。

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@xiawan-play/steam-tools-mcp",
+  "version": "0.1.0",
+  "description": "A Steam MCP server with Chinese-friendly high-level tools and optional generated official methods.",
+  "type": "module",
+  "license": "MIT",
+  "main": "./dist/server.js",
+  "types": "./dist/server.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/server.d.ts",
+      "default": "./dist/server.js"
+    }
+  },
+  "bin": {
+    "steam-tools-mcp": "dist/server.js"
+  },
+  "files": [
+    "dist",
+    "docs",
+    "README.md",
+    ".env.example"
+  ],
+  "keywords": [
+    "mcp",
+    "model-context-protocol",
+    "steam",
+    "steam-tools",
+    "steam-web-api",
+    "steamworks"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/XiaWan-Play/steam-tools-mcp.git"
+  },
+  "homepage": "https://github.com/XiaWan-Play/steam-tools-mcp#readme",
+  "bugs": {
+    "url": "https://github.com/XiaWan-Play/steam-tools-mcp/issues"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "scripts": {
+    "dev": "tsx src/server.ts",
+    "build": "tsup src/server.ts --format esm --dts --clean",
+    "start": "node dist/server.js",
+    "sync:steam-spec": "tsx scripts/sync-steam-web-api-spec.ts",
+    "prepare": "npm run build"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.27.1",
+    "cheerio": "^1.2.0",
+    "zod": "^4.3.6"
+  },
+  "devDependencies": {
+    "@types/express": "^5.0.3",
+    "@types/node": "^24.6.1",
+    "tsup": "^8.5.1",
+    "tsx": "^4.20.6",
+    "typescript": "^5.9.3"
+  }
+}