🛠️ Update various documentation, scripts, and configuration templates to enhance clarity, functionality, and maintainability across the project
This commit is contained in:
@@ -1,5 +1,38 @@
|
||||
# MCP Notes
|
||||
|
||||
This folder is reserved for reusable MCP references and safe shared
|
||||
configuration snippets. Machine-specific secrets and authenticated local server
|
||||
definitions should stay out of the repository.
|
||||
This repository manages shared MCP configuration through tracked templates plus
|
||||
machine-local overrides.
|
||||
|
||||
## What Is Tracked
|
||||
|
||||
- Shared templates live in `config/mcp/`.
|
||||
- The merge logic lives in `install/merge-managed-mcp-config.mjs`.
|
||||
- The Copilot CLI filesystem wrapper lives in `install/mcp/`.
|
||||
|
||||
## What Stays Local
|
||||
|
||||
- Machine-local values live in `.local/mcp.local.jsonc`.
|
||||
- Secrets stay in that local file and are never committed.
|
||||
- Bootstrap creates `.local/mcp.local.jsonc` from
|
||||
`config/mcp/local-overrides.example.jsonc` if it does not exist yet.
|
||||
|
||||
## Generated Outputs
|
||||
|
||||
- VS Code user MCP config: user-profile `mcp.json`
|
||||
- Copilot CLI user MCP config: `~/.copilot/mcp-config.json`
|
||||
|
||||
Bootstrap and update regenerate those managed files while preserving unmanaged
|
||||
entries already present in the user config.
|
||||
|
||||
## Managed Servers
|
||||
|
||||
- Playwright: generated for VS Code with `npx @playwright/mcp@latest`
|
||||
- Filesystem: generated for VS Code with Docker and `${workspaceFolder}` binding
|
||||
- Filesystem: generated for Copilot CLI with a repo-owned Node wrapper that
|
||||
binds the current working directory into Docker
|
||||
- Gitea/Forgejo: generated for VS Code and Copilot CLI with
|
||||
`ronmi/forgejo-mcp`, but only when `.local/mcp.local.jsonc` enables it and
|
||||
provides `serverUrl` plus `token`
|
||||
|
||||
Copilot CLI Playwright is not generated here because Copilot CLI already ships a
|
||||
built-in Playwright MCP server.
|
||||
|
||||
Reference in New Issue
Block a user