@ecubelabs/mysql-mcp 1.1.0-next.2 → 1.1.0
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.
- package/README.md +18 -18
- package/dist/src/config/index.js +15 -8
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -29,7 +29,7 @@ Tunnel은 서버가 직접 엽니다. 이미 쓰고 있는 `~/.ssh/config` alias
|
|
|
29
29
|
|
|
30
30
|
## 요구 사항
|
|
31
31
|
|
|
32
|
-
- Node.js 18 이상
|
|
32
|
+
- Node.js 18.7 이상
|
|
33
33
|
- Bastion에 대한 SSH 접근 권한, 그리고 이미 동작하는 키(`ssh <alias>`가 성공할 것)
|
|
34
34
|
- 대상 데이터베이스의 MySQL 사용자 계정
|
|
35
35
|
|
|
@@ -407,25 +407,25 @@ profile과 alias는 환경 변수가 아니라 서버 실행 인자로 받습니
|
|
|
407
407
|
|
|
408
408
|
### Profile
|
|
409
409
|
|
|
410
|
-
| 변수 | 기본값 | 의미
|
|
411
|
-
| ------------------------- | ---------------------------- |
|
|
412
|
-
| `MYSQL_PROFILE` | _(미설정)_ | **Deprecated.** `--profile`을 쓰세요. 인자가 없을 때만
|
|
413
|
-
| `MYSQL_CATALOG_ENABLED` | `true` | 로컬 schema catalog를 켭니다. `false`이면 `mysql_catalog` 툴과 `mysql://schemas`가 제공되지 않습니다.
|
|
414
|
-
| `MYSQL_CATALOG_PATH` | `~/.cache/mysql-mcp/catalog` | profile·대상·user별 JSON 파일을 둘 directory입니다.
|
|
415
|
-
| `MYSQL_CATALOG_TTL_HOURS` | `24` | DB metadata를 stale로 보는 시간입니다.
|
|
410
|
+
| 변수 | 기본값 | 의미 |
|
|
411
|
+
| ------------------------- | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
412
|
+
| `MYSQL_PROFILE` | _(미설정)_ | **Deprecated.** `--profile`을 쓰세요. 인자가 없을 때만 씁니다. 남아 있으면 stderr에 알립니다. 환경 label. `prod`로 시작하는 label은 읽기 전용을 강제합니다. |
|
|
413
|
+
| `MYSQL_CATALOG_ENABLED` | `true` | 로컬 schema catalog를 켭니다. `false`이면 `mysql_catalog` 툴과 `mysql://schemas`가 제공되지 않습니다. |
|
|
414
|
+
| `MYSQL_CATALOG_PATH` | `~/.cache/mysql-mcp/catalog` | profile·대상·user별 JSON 파일을 둘 directory입니다. |
|
|
415
|
+
| `MYSQL_CATALOG_TTL_HOURS` | `24` | DB metadata를 stale로 보는 시간입니다. |
|
|
416
416
|
|
|
417
417
|
### SSH tunnel
|
|
418
418
|
|
|
419
|
-
| 변수 | 기본값 | 의미
|
|
420
|
-
| ---------------------------- | -------------------------------------------- |
|
|
421
|
-
| `MYSQL_SSH_CONFIG_HOST` | _(미설정)_ | **Deprecated.** `--ssh-config-host`를 쓰세요. 인자가 없을 때만
|
|
422
|
-
| `MYSQL_SSH_HOST` | alias에서 | bastion 호스트명.
|
|
423
|
-
| `MYSQL_SSH_PORT` | alias `Port`, 없으면 `22` | bastion SSH 포트.
|
|
424
|
-
| `MYSQL_SSH_USER` | alias에서 | bastion 사용자.
|
|
425
|
-
| `MYSQL_SSH_PRIVATE_KEY_PATH` | alias `IdentityFile`, 없으면 `~/.ssh/id_rsa` | bastion 인증에 쓰는 키.
|
|
426
|
-
| `MYSQL_SSH_PASSPHRASE` | _(미설정)_ | 암호화된 키일 때만 필요합니다.
|
|
427
|
-
| `MYSQL_SSH_LOCAL_PORT` | alias `LocalForward`, 없으면 `0` | 선호하는 loopback 포트. `0`은 자동 할당. 포트가 이미 쓰이고 있으면 자동 할당된 포트를 대신 씁니다.
|
|
428
|
-
| `MYSQL_SSH_REUSE_EXISTING` | `false` | 직접 열지 않고 해당 포트에 이미 떠 있는 forward에 붙습니다. 아래 경고를 참고하세요.
|
|
419
|
+
| 변수 | 기본값 | 의미 |
|
|
420
|
+
| ---------------------------- | -------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
|
421
|
+
| `MYSQL_SSH_CONFIG_HOST` | _(미설정)_ | **Deprecated.** `--ssh-config-host`를 쓰세요. 인자가 없을 때만 씁니다. 남아 있으면 stderr에 알립니다. |
|
|
422
|
+
| `MYSQL_SSH_HOST` | alias에서 | bastion 호스트명. |
|
|
423
|
+
| `MYSQL_SSH_PORT` | alias `Port`, 없으면 `22` | bastion SSH 포트. |
|
|
424
|
+
| `MYSQL_SSH_USER` | alias에서 | bastion 사용자. |
|
|
425
|
+
| `MYSQL_SSH_PRIVATE_KEY_PATH` | alias `IdentityFile`, 없으면 `~/.ssh/id_rsa` | bastion 인증에 쓰는 키. |
|
|
426
|
+
| `MYSQL_SSH_PASSPHRASE` | _(미설정)_ | 암호화된 키일 때만 필요합니다. |
|
|
427
|
+
| `MYSQL_SSH_LOCAL_PORT` | alias `LocalForward`, 없으면 `0` | 선호하는 loopback 포트. `0`은 자동 할당. 포트가 이미 쓰이고 있으면 자동 할당된 포트를 대신 씁니다. |
|
|
428
|
+
| `MYSQL_SSH_REUSE_EXISTING` | `false` | 직접 열지 않고 해당 포트에 이미 떠 있는 forward에 붙습니다. 아래 경고를 참고하세요. |
|
|
429
429
|
|
|
430
430
|
- alias(`--ssh-config-host`)나 `MYSQL_SSH_HOST`가 있으면 접속
|
|
431
431
|
전에 tunnel을 엽니다. 둘 다 없으면 tunnel 없이 `MYSQL_HOST`로 직접 접속합니다.
|
|
@@ -867,7 +867,7 @@ git remote set-url origin git@github.com:<owner>/<repo>.git
|
|
|
867
867
|
|
|
868
868
|
이 절은 이 패키지를 고치는 사람을 위한 것입니다. 개발에는 devDependency인 vitest
|
|
869
869
|
5가 요구하는 Node.js(`^22.12.0 || ^24.0.0 || >=26.0.0`)가 필요합니다. 서버 실행은
|
|
870
|
-
18이면 됩니다.
|
|
870
|
+
18.7이면 됩니다.
|
|
871
871
|
|
|
872
872
|
```bash
|
|
873
873
|
git clone git@github.com:Ecube-Labs/skynet.git
|
package/dist/src/config/index.js
CHANGED
|
@@ -96,25 +96,32 @@ function parseServerArgv(argv) {
|
|
|
96
96
|
});
|
|
97
97
|
}
|
|
98
98
|
const SERVER_ARGS = parseServerArgs(process.argv.slice(2));
|
|
99
|
-
function readDeprecatedEnv(name,
|
|
99
|
+
function readDeprecatedEnv(name, flag, placeholder, argValue, normalize = (value) => value) {
|
|
100
100
|
const value = process.env[name]?.trim() || undefined;
|
|
101
|
-
if (value) {
|
|
102
|
-
|
|
101
|
+
if (!value) {
|
|
102
|
+
return undefined;
|
|
103
|
+
}
|
|
104
|
+
if (argValue === undefined) {
|
|
105
|
+
console.error(`[config] ${name} is deprecated; pass ${flag} ${placeholder} as a server argument instead.`);
|
|
106
|
+
}
|
|
107
|
+
else if (normalize(value) === normalize(argValue)) {
|
|
108
|
+
console.error(`[config] ${name} is ignored because ${flag} is given. Remove ${name} from the server env.`);
|
|
109
|
+
}
|
|
110
|
+
else {
|
|
111
|
+
console.error(`[config] ${flag} "${normalize(argValue)}" overrides ${name}="${normalize(value)}". ` +
|
|
112
|
+
`Remove ${name} from the server env.`);
|
|
103
113
|
}
|
|
104
114
|
return value;
|
|
105
115
|
}
|
|
106
116
|
function normalizeProfile(raw) {
|
|
107
117
|
return (raw ?? '').trim().toLowerCase();
|
|
108
118
|
}
|
|
109
|
-
const ENV_PROFILE = normalizeProfile(readDeprecatedEnv('MYSQL_PROFILE', '--profile <label>'));
|
|
119
|
+
const ENV_PROFILE = normalizeProfile(readDeprecatedEnv('MYSQL_PROFILE', '--profile', '<label>', SERVER_ARGS.profile, normalizeProfile));
|
|
110
120
|
export const MYSQL_PROFILE = SERVER_ARGS.profile ? normalizeProfile(SERVER_ARGS.profile) : ENV_PROFILE;
|
|
111
121
|
export function isWriteForbiddenProfile(profile) {
|
|
112
122
|
return normalizeProfile(profile).startsWith('prod');
|
|
113
123
|
}
|
|
114
124
|
export const IS_WRITE_FORBIDDEN_PROFILE = isWriteForbiddenProfile(MYSQL_PROFILE);
|
|
115
|
-
if (SERVER_ARGS.profile && ENV_PROFILE && ENV_PROFILE !== MYSQL_PROFILE) {
|
|
116
|
-
console.error(`[config] --profile "${MYSQL_PROFILE}" overrides MYSQL_PROFILE="${ENV_PROFILE}".`);
|
|
117
|
-
}
|
|
118
125
|
export const PROFILE_LABEL = MYSQL_PROFILE ? MYSQL_PROFILE.toUpperCase() : 'UNSPECIFIED';
|
|
119
126
|
export const MYSQL_CATALOG_ENABLED = process.env.MYSQL_CATALOG_ENABLED !== 'false';
|
|
120
127
|
export const MYSQL_CATALOG_PATH = process.env.MYSQL_CATALOG_PATH?.trim() || undefined;
|
|
@@ -197,7 +204,7 @@ export const MYSQL_TIMEZONE = process.env.MYSQL_TIMEZONE?.trim() || undefined;
|
|
|
197
204
|
export const MYSQL_DATE_STRINGS = process.env.MYSQL_DATE_STRINGS === 'true';
|
|
198
205
|
export const MYSQL_BIG_NUMBER_STRINGS = process.env.MYSQL_BIG_NUMBER_STRINGS === 'true';
|
|
199
206
|
export const SSH_REUSE_EXISTING = process.env.MYSQL_SSH_REUSE_EXISTING === 'true';
|
|
200
|
-
const ENV_SSH_CONFIG_HOST = readDeprecatedEnv('MYSQL_SSH_CONFIG_HOST', '--ssh-config-host <alias>');
|
|
207
|
+
const ENV_SSH_CONFIG_HOST = readDeprecatedEnv('MYSQL_SSH_CONFIG_HOST', '--ssh-config-host', '<alias>', SERVER_ARGS.sshConfigHost, (value) => value.trim().toLowerCase());
|
|
201
208
|
export const SSH_CONFIG_HOST = SERVER_ARGS.sshConfigHost ?? ENV_SSH_CONFIG_HOST;
|
|
202
209
|
export const SSH_CONFIG_HOST_SOURCE = SERVER_ARGS.sshConfigHost ? '--ssh-config-host' : ENV_SSH_CONFIG_HOST ? 'MYSQL_SSH_CONFIG_HOST' : undefined;
|
|
203
210
|
export const SSH_HOST = process.env.MYSQL_SSH_HOST?.trim() || undefined;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ecubelabs/mysql-mcp",
|
|
3
|
-
"version": "1.1.0
|
|
3
|
+
"version": "1.1.0",
|
|
4
4
|
"description": "Read-only MySQL MCP server that reaches its database through an SSH bastion, with per-environment profiles",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
},
|
|
13
13
|
"type": "module",
|
|
14
14
|
"engines": {
|
|
15
|
-
"node": ">=18"
|
|
15
|
+
"node": ">=18.7"
|
|
16
16
|
},
|
|
17
17
|
"main": "dist/index.js",
|
|
18
18
|
"bin": "dist/index.js",
|