@xiawan-play/steam-tools-mcp 0.2.0 → 0.3.0

package/docs/configuration.md

@@ -1,73 +1,76 @@
-# 配置参数说明
-
-这份文档列出 `@xiawan-play/steam-tools-mcp` 当前支持的全部环境变量，并说明默认值、用途和推荐使用场景。
-
-README 里的 MCP 配置示例只保留最常用的 2 项：
-
-- `STEAM_WEB_API_KEY`
-- `STEAM_DEFAULT_STEAMID`
-
-如果你需要更细的控制，再参考本文即可。
-
-## 常用参数
-
-| 变量名 | 默认值 | 作用 | 什么时候建议配置 |
-| --- | --- | --- | --- |
-| `STEAM_WEB_API_KEY` | 无 | 默认使用的 Steam Web API Key。很多资料、游戏库、成就、应用目录相关接口都依赖它。 | 只要你要查“我的资料 / 我的库 / 我的成就”这类信息，就建议配置。 |
-| `STEAM_DEFAULT_STEAMID` | 无 | 默认查询账号的 SteamID64。`steam_me_*` 工具和部分带 `steamid` / `steamids` 的工具会自动使用它。 | 你长期绑定自己的账号使用时，强烈建议配置。 |
-
-## 高级可选参数
-
-| 变量名 | 默认值 | 作用 | 备注 |
-| --- | --- | --- | --- |
-| `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_WEB_API_KEY` 和 `STEAM_DEFAULT_STEAMID`。
-- 如果你的 MCP 客户端会直接拉起本地进程，通常不需要配置 `MCP_TRANSPORT`、`HOST`、`PORT`。
-- 如果你不需要调优缓存和网络行为，可以完全不配置 `STEAM_APP_LIST_CACHE_TTL_MS` 和 `STEAM_REQUEST_TIMEOUT_MS`。
-
-## 当前读取位置
-
-当前这些环境变量主要在源码中的 `src/server.ts` 里读取。
-
-如果后续新增参数，建议同步更新本文档。
+# 配置参数说明
+
+这份文档列出 `@xiawan-play/steam-tools-mcp` 当前支持的全部环境变量，并说明默认值、用途和推荐使用场景。
+
+README 里的 MCP 配置示例只保留最常用的 2 项：
+
+- `STEAM_WEB_API_KEY`
+- `STEAM_DEFAULT_STEAMID`
+
+如果你需要更细的控制，再参考本文即可。
+
+## 常用参数
+
+| 变量名 | 默认值 | 作用 | 什么时候建议配置 |
+| --- | --- | --- | --- |
+| `STEAM_WEB_API_KEY` | 无 | 默认使用的 Steam Web API Key。很多资料、游戏库、成就、应用目录相关接口都依赖它。 | 只要你要查“我的资料 / 我的库 / 我的成就”这类信息，就建议配置。 |
+| `STEAM_DEFAULT_STEAMID` | 无 | 默认查询账号的 SteamID64。`steam_me_*` 工具和部分带 `steamid` / `steamids` 的工具会自动使用它。 | 你长期绑定自己的账号使用时，强烈建议配置。 |
+
+## 高级可选参数
+
+| 变量名 | 默认值 | 作用 | 备注 |
+| --- | --- | --- | --- |
+| `STEAM_APP_LIST_CACHE_TTL_MS` | `21600000` | Steam 应用目录缓存时间，单位毫秒。 | 主要影响 `steam_search_apps` / `steam_resolve_app` 等应用目录相关工具。 |
+| `STEAM_REQUEST_TIMEOUT_MS` | `30000` | Steam API 请求超时时间，单位毫秒。 | 网络较慢、代理链路较长时可调大。 |
+| `PROXY_URL` | 无 | 项目统一使用的代理环境变量。 | 配置后会用于所有外部 HTTP 请求。 |
+
+## 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",
+    "PROXY_URL": "http://YOUR_PROXY_HOST:PORT"
+  }
+}
+```
+
+## 使用建议
+
+- 如果你主要是自己用，推荐至少配置 `STEAM_WEB_API_KEY` 和 `STEAM_DEFAULT_STEAMID`。
+- 如果你的浏览器或 Steam 客户端可以打开社区页，但终端里的请求抓不到 `steamcommunity.com`，优先配置 `PROXY_URL`。
+- 如果你的 MCP 客户端会直接拉起本地进程，通常不需要配置 `MCP_TRANSPORT`、`HOST`、`PORT`。
+- 如果你不需要调优缓存和网络行为，可以完全不配置 `STEAM_APP_LIST_CACHE_TTL_MS` 和 `STEAM_REQUEST_TIMEOUT_MS`。
+
+## 当前读取位置
+
+当前这些环境变量主要在源码中的 `src/server.ts` 里读取。
+
+如果后续新增参数，建议同步更新本文档。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xiawan-play/steam-tools-mcp",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "A Steam MCP server with Chinese-friendly high-level tools for profiles, libraries, game snapshots, achievements, and app discovery.",
   "type": "module",
   "license": "MIT",