fa-mcp-sdk 0.4.45 → 0.4.46

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -138,10 +138,11 @@ Alternative approach — use the npm registry to get git metadata, or simply rea
138
138
  These config files in the SDK may have changed and require corresponding updates in the project:
139
139
 
140
140
  - `config/default.yaml` — main configuration defaults
141
+ - `config/_local.yaml` — local config template (the CLI scaffolder copies this to the project's `config/_local.yaml` and derives `config/local.yaml` from it with `{{param}}` substitutions)
141
142
  - `config/custom-environment-variables.yaml` — env var mappings
142
143
  - `config/development.yaml` — dev overrides
143
144
  - `config/production.yaml` — production overrides
144
- - `config/local.yaml` — local secrets template
145
+ - `config/local.yaml` (SDK's own) reference only, not shipped to projects
145
146
 
146
147
  For each config file, compare the SDK's version (at `node_modules/fa-mcp-sdk/config/<file>`) with the project's version (at `config/<file>`).
147
148
 
@@ -151,6 +152,24 @@ Identify:
151
152
  - **Changed defaults** where the SDK's default value has changed
152
153
  - **New sections** that represent new features
153
154
 
155
+ **Correlate changes across config files.** When `config/default.yaml` has changes (new keys, restructured sections, changed defaults), you MUST also check `config/_local.yaml` for analogous changes. The `_local.yaml` file mirrors the structure of `default.yaml` but contains local-override values — if a section was added or restructured in `default.yaml`, the same section likely needs updating in `_local.yaml`.
156
+
157
+ Compare both files in the SDK's `node_modules/fa-mcp-sdk/config/`:
158
+ - `node_modules/fa-mcp-sdk/config/default.yaml` — the canonical defaults
159
+ - `node_modules/fa-mcp-sdk/config/_local.yaml` — the template that was used to generate the project's `config/local.yaml`
160
+
161
+ If `default.yaml` changed but `_local.yaml` did NOT, explicitly note this in the guide: the project's `config/_local.yaml` may still need manual updates to stay consistent with the new `default.yaml` structure.
162
+
163
+ **Config file mapping (SDK source → project destination):**
164
+
165
+ | SDK source (in `config/`) | Project destination | Action |
166
+ |--------------------------------------|---------------------------------|--------|
167
+ | `config/default.yaml` | `config/default.yaml` | Add new keys; do NOT remove existing keys the project may have customized |
168
+ | `config/_local.yaml` | `config/_local.yaml` | Update to match SDK — this is the template users derive their `local.yaml` from |
169
+ | `config/_local.yaml` (via CLI) | `config/local.yaml` | Derived by CLI from `_local.yaml` with `{{param}}` substitutions — check for needed adjustments |
170
+ | `config/custom-environment-variables.yaml` | `config/custom-environment-variables.yaml` | Add new env var mappings |
171
+ | `config/local.yaml` (SDK's own) | *(not shipped — reference only)* | Use as reference for what the SDK itself overrides locally |
172
+
154
173
  ### 4.3 Analyze changes in cli-template files
155
174
 
156
175
  The SDK ships a project template at `node_modules/fa-mcp-sdk/cli-template/` (after `yarn add fa-mcp-sdk@<TO>`). This is the **canonical source** for any template files in the project — when generating instructions for the user, always point to this path as the place to copy the latest version from.
@@ -287,6 +306,14 @@ Generated: <timestamp>
287
306
  <actual YAML snippets to add>
288
307
  ```
289
308
 
309
+ ### config/_local.yaml
310
+
311
+ <If `default.yaml` changed, check whether `_local.yaml` in the SDK also changed. If it did: describe what changed. If it did NOT but the `default.yaml` changes affect keys that also exist in `_local.yaml` (because `_local.yaml` overrides those keys), explicitly warn that the project's `config/_local.yaml` may need manual updates to stay consistent with the new `default.yaml` structure.>
312
+
313
+ ### config/local.yaml (project-local overrides)
314
+
315
+ <Check whether the project's `config/local.yaml` overrides keys that changed in `default.yaml` or `_local.yaml`. This is especially important when: a new key is added to `default.yaml` that the project's `local.yaml` doesn't override (user just needs to know it exists); a key's meaning or structure changed and `local.yaml` has a stale override; `local.yaml` was derived from the old `_local.yaml` and needs re-derivation from the updated template.>
316
+
290
317
  ### Recommended config/custom-environment-variables.yaml additions
291
318
 
292
319
  ```yaml
@@ -374,6 +401,8 @@ changes specifically affect THIS project. Add a section to the guide:
374
401
 
375
402
  - ALWAYS read the actual files to compare — do not guess or assume what changed.
376
403
  - When comparing YAML configs, preserve comments and structure.
404
+ - **Correlate config file changes**: when `config/default.yaml` changes, ALWAYS also check `config/_local.yaml` in the SDK. Report whether `_local.yaml` has analogous changes or needs manual updates. Also advise checking the project's `config/local.yaml` for stale overrides that may conflict with the new defaults.
405
+ - **Do not forget `config/local.yaml` in the project**: the project's `config/local.yaml` overrides `config/default.yaml`. When new keys are added or sections restructured in `default.yaml`, explicitly instruct the user to verify that their `config/local.yaml` doesn't have stale overrides that conflict with the new structure, and to add any new keys there too if they want non-default values.
377
406
  - Do not modify project files other than `package.json` (via yarn add) and `FA-MCP-SDK-DOC/` (via update-doc.js) unless the user explicitly asks.
378
407
  - The migration guide must contain ACTIONABLE instructions with exact code/config snippets — not vague recommendations.
379
408
  - If GitHub API is unavailable or rate-limited, fall back to comparing files directly from `node_modules/fa-mcp-sdk/` against project files.
@@ -50,7 +50,7 @@
50
50
  "dependencies": {
51
51
  "@modelcontextprotocol/sdk": "^1.29.0",
52
52
  "dotenv": "^17.4.1",
53
- "fa-mcp-sdk": "^0.4.45"
53
+ "fa-mcp-sdk": "^0.4.46"
54
54
  },
55
55
  "devDependencies": {
56
56
  "@types/express": "^5.0.6",
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "fa-mcp-sdk",
3
3
  "productName": "FA MCP SDK",
4
- "version": "0.4.45",
4
+ "version": "0.4.46",
5
5
  "description": "Core infrastructure and templates for building Model Context Protocol (MCP) servers with TypeScript",
6
6
  "type": "module",
7
7
  "main": "dist/core/index.js",