@keke1933/vibe-dictionary-mcp 0.1.0 → 0.1.1

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.
Files changed (4) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +62 -62
  3. package/dist/index.js +1 -1
  4. package/package.json +41 -41
package/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2026 leejh96
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2026 leejh96
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,62 +1,62 @@
1
- # Vibe Dictionary MCP
2
-
3
- 바이브 코딩 사전의 기법을 검색하고 구현용 프롬프트 원문을 가져오는 읽기 전용 로컬 MCP다. Node.js 22.12 이상이 필요하며, 현재 검증 환경은 Node.js 24다.
4
-
5
- ## 제공하는 도구
6
-
7
- | 도구 | 입력 | 결과 |
8
- | --- | --- | --- |
9
- | `search_techniques` | 선택 사항: `query`, `domain`, `category`, `limit`, `offset` | 기법 ID·이름·분류·요약과 페이지 정보 |
10
- | `get_technique` | 필수: `id` | 기법 상세·키워드·`promptSnippet` 원문 |
11
-
12
- `query`를 생략하면 전체 목록을 조회한다. 공백으로 나눈 검색어를 모두 포함하는 항목을 찾으며, 영문 대소문자를 구분하지 않는다. 검색 대상은 한·영 이름, 효과 태그, 키워드, 요약과 프롬프트다. 문장 의미를 추론하는 검색은 아니므로 `마그네틱`, `magnetic`, `카드`, `SVG`처럼 짧은 검색어를 사용한다.
13
-
14
- 도메인은 `ui`(UI), `motion`(그래픽), `layout`(레이아웃), `style`(스타일), `video`(모션 영상)다. 카테고리 ID는 도구의 입력 스키마와 검색 결과에서 확인한다. 도메인·카테고리 필터를 함께 지정하면 둘 다 만족해야 한다. 검색 결과는 카탈로그 순서이며 관련도 순위는 제공하지 않는다.
15
-
16
- 검색 결과의 `total`은 필터와 검색 조건에 맞는 전체 개수다. 기본 페이지 크기는 20, 최대는 50이며 `nextOffset`을 다음 요청의 `offset`으로 보내면 이어서 조회한다. `nextOffset: null`이면 마지막 페이지다. 일치 항목이 없으면 빈 목록을 반환한다. 잘못된 입력과 존재하지 않는 상세 ID는 MCP 오류 결과를 반환한다.
17
-
18
- 검색 결과에는 프롬프트 전문을 넣지 않는다. 선택한 기법을 `get_technique`로 조회하면 웹과 같은 원문을 받을 수 있다. MCP 자체는 조합·클립보드 접근·프로젝트 파일 수정·UI 생성·외부 API 호출을 수행하지 않는다. 구현은 연결한 코딩 에이전트가 사용자 요청에 따라 수행한다.
19
-
20
- ## 현재 연결 방법
21
-
22
- npm 이름은 `@keke1933/vibe-dictionary-mcp`다. npm 공개 게시와 Trusted Publisher 설정은 별도로 완료해야 한다. 게시 전에는 저장소에서 다음 명령으로 로컬 빌드를 사용한다.
23
-
24
- ```sh
25
- npm ci
26
- npm run build:mcp
27
- ```
28
-
29
- Codex에는 빌드 결과의 **실제 절대 경로**로 등록한다. 아래 자리표시자는 자신의 경로로 바꾼다. `node`가 Codex의 PATH에 없다면 Node 실행 파일도 절대 경로로 지정한다.
30
-
31
- ```sh
32
- codex mcp add vibe-dictionary -- node "/absolute/path/to/vibe-dictionary/apps/mcp/dist/index.js"
33
- codex mcp get vibe-dictionary
34
- ```
35
-
36
- 현재 사용 중인 Codex 세션에 도구가 나타나지 않으면 앱의 MCP 서버 재시작 기능을 사용하거나 새 세션에서 확인한다. 다음과 같이 요청하고 실제 도구 호출과 반환된 `promptSnippet`을 확인한다.
37
-
38
- > vibe-dictionary MCP에서 마그네틱 기법을 검색한 뒤 magnetic-hover의 프롬프트 원문을 가져와 줘. 코드는 수정하지 마.
39
-
40
- 다른 MCP 클라이언트도 `stdio` 서버로 등록하고 명령을 `node`, 인수를 같은 빌드 파일의 절대 경로로 지정하면 된다. 설정 형식은 클라이언트별로 다르다. 표준 출력은 MCP 통신 전용이므로 등록 명령을 `npm run start`로 감싸지 않는다.
41
-
42
- ## 데이터와 배포
43
-
44
- 기법 데이터와 검색 함수는 내부 패키지 `@vibe-dictionary/catalog`로 웹과 공유하며 빌드 시 실행 파일에 포함된다. 카탈로그는 빌드 전용 의존성이므로 사용자 설치 시 별도로 가져오지 않는다. 실행 중에는 웹 접속·API 키·네트워크 연결이 필요 없다. 패키지 다운로드와 의존성 설치 시에는 네트워크가 필요하다. 카탈로그 변경은 재빌드하고 MCP 프로세스를 재시작해야 반영된다. npm 배포 이후에는 새 패키지 버전도 게시해야 한다.
45
-
46
- 저장소에서 `npm test`는 웹 회귀 테스트와 빌드된 MCP의 실제 stdio 연결 테스트를 함께 실행한다. `npm run build`는 웹과 MCP 전체 빌드, `npm run build:web`은 웹만, `npm run build:mcp`는 MCP만 빌드한다.
47
-
48
- 저장소 루트에서 다음 명령으로 배포 파일을 검증할 수 있다. 실행 파일·이 문서·LICENSE·패키지 메타데이터 4개만 포함하는지 검사하고, tarball을 임시 경로에 설치해 도구 목록과 모든 기법·프롬프트 원문을 대조한다. 설치에는 npm 레지스트리 연결이 필요하다. 최종 tarball 경로를 출력하며, 임시 설치 폴더는 정리한다.
49
-
50
- ```sh
51
- npm run check:package
52
- ```
53
-
54
- 공개 게시가 완료된 버전은 MCP 클라이언트에서 `npx` 실행 파일과 `-y`, `@keke1933/vibe-dictionary-mcp@<게시된 버전>` 인수로 실행할 수 있다. 예를 들어 터미널 실행 명령은 `npx -y @keke1933/vibe-dictionary-mcp@0.1.0`이다. 실제 게시 전에는 이 명령으로 패키지를 받을 수 없다. 클라이언트의 실행 파일 검색 방식과 Windows의 `.cmd` 처리에 맞춰 설정한다.
55
-
56
- 저장소 관리자는 GitHub Actions의 `Publish MCP to npm`을 `master`에서 수동 실행한다. 입력한 버전은 이미 커밋된 MCP 버전과 같아야 하며, GitHub `npm` environment와 npm Trusted Publisher를 사전에 설정한다. 최초 1회 패키지 생성·2FA 게시와 설정값은 저장소의 `docs/npm-publishing.md`를 참고한다. npm 토큰을 GitHub Secrets에 추가할 필요는 없다.
57
-
58
- ## 라이선스
59
-
60
- MCP 코드와 번들에 포함된 기법 데이터·프롬프트는 [MIT License](LICENSE)를 따른다. 제3자 의존성은 각각의 라이선스를 따른다.
61
-
62
- 연결 방식의 근거: [MCP 공식 SDK](https://ts.sdk.modelcontextprotocol.io/server), [Codex 공식 MCP 문서](https://developers.openai.com/codex/mcp).
1
+ # Vibe Dictionary MCP
2
+
3
+ 바이브 코딩 사전의 기법을 검색하고 구현용 프롬프트 원문을 가져오는 읽기 전용 로컬 MCP다. Node.js 22.12 이상이 필요하며, 현재 검증 환경은 Node.js 24다.
4
+
5
+ ## 제공하는 도구
6
+
7
+ | 도구 | 입력 | 결과 |
8
+ | --- | --- | --- |
9
+ | `search_techniques` | 선택 사항: `query`, `domain`, `category`, `limit`, `offset` | 기법 ID·이름·분류·요약과 페이지 정보 |
10
+ | `get_technique` | 필수: `id` | 기법 상세·키워드·`promptSnippet` 원문 |
11
+
12
+ `query`를 생략하면 전체 목록을 조회한다. 공백으로 나눈 검색어를 모두 포함하는 항목을 찾으며, 영문 대소문자를 구분하지 않는다. 검색 대상은 한·영 이름, 효과 태그, 키워드, 요약과 프롬프트다. 문장 의미를 추론하는 검색은 아니므로 `마그네틱`, `magnetic`, `카드`, `SVG`처럼 짧은 검색어를 사용한다.
13
+
14
+ 도메인은 `ui`(UI), `motion`(그래픽), `layout`(레이아웃), `style`(스타일), `video`(모션 영상)다. 카테고리 ID는 도구의 입력 스키마와 검색 결과에서 확인한다. 도메인·카테고리 필터를 함께 지정하면 둘 다 만족해야 한다. 검색 결과는 카탈로그 순서이며 관련도 순위는 제공하지 않는다.
15
+
16
+ 검색 결과의 `total`은 필터와 검색 조건에 맞는 전체 개수다. 기본 페이지 크기는 20, 최대는 50이며 `nextOffset`을 다음 요청의 `offset`으로 보내면 이어서 조회한다. `nextOffset: null`이면 마지막 페이지다. 일치 항목이 없으면 빈 목록을 반환한다. 잘못된 입력과 존재하지 않는 상세 ID는 MCP 오류 결과를 반환한다.
17
+
18
+ 검색 결과에는 프롬프트 전문을 넣지 않는다. 선택한 기법을 `get_technique`로 조회하면 웹과 같은 원문을 받을 수 있다. MCP 자체는 조합·클립보드 접근·프로젝트 파일 수정·UI 생성·외부 API 호출을 수행하지 않는다. 구현은 연결한 코딩 에이전트가 사용자 요청에 따라 수행한다.
19
+
20
+ ## 현재 연결 방법
21
+
22
+ npm 이름은 `@keke1933/vibe-dictionary-mcp`다. npm 공개 게시와 Trusted Publisher 설정은 별도로 완료해야 한다. 게시 전에는 저장소에서 다음 명령으로 로컬 빌드를 사용한다.
23
+
24
+ ```sh
25
+ npm ci
26
+ npm run build:mcp
27
+ ```
28
+
29
+ Codex에는 빌드 결과의 **실제 절대 경로**로 등록한다. 아래 자리표시자는 자신의 경로로 바꾼다. `node`가 Codex의 PATH에 없다면 Node 실행 파일도 절대 경로로 지정한다.
30
+
31
+ ```sh
32
+ codex mcp add vibe-dictionary -- node "/absolute/path/to/vibe-dictionary/apps/mcp/dist/index.js"
33
+ codex mcp get vibe-dictionary
34
+ ```
35
+
36
+ 현재 사용 중인 Codex 세션에 도구가 나타나지 않으면 앱의 MCP 서버 재시작 기능을 사용하거나 새 세션에서 확인한다. 다음과 같이 요청하고 실제 도구 호출과 반환된 `promptSnippet`을 확인한다.
37
+
38
+ > vibe-dictionary MCP에서 마그네틱 기법을 검색한 뒤 magnetic-hover의 프롬프트 원문을 가져와 줘. 코드는 수정하지 마.
39
+
40
+ 다른 MCP 클라이언트도 `stdio` 서버로 등록하고 명령을 `node`, 인수를 같은 빌드 파일의 절대 경로로 지정하면 된다. 설정 형식은 클라이언트별로 다르다. 표준 출력은 MCP 통신 전용이므로 등록 명령을 `npm run start`로 감싸지 않는다.
41
+
42
+ ## 데이터와 배포
43
+
44
+ 기법 데이터와 검색 함수는 내부 패키지 `@vibe-dictionary/catalog`로 웹과 공유하며 빌드 시 실행 파일에 포함된다. 카탈로그는 빌드 전용 의존성이므로 사용자 설치 시 별도로 가져오지 않는다. 실행 중에는 웹 접속·API 키·네트워크 연결이 필요 없다. 패키지 다운로드와 의존성 설치 시에는 네트워크가 필요하다. 카탈로그 변경은 재빌드하고 MCP 프로세스를 재시작해야 반영된다. npm 배포 이후에는 새 패키지 버전도 게시해야 한다.
45
+
46
+ 저장소에서 `npm test`는 웹 회귀 테스트와 빌드된 MCP의 실제 stdio 연결 테스트를 함께 실행한다. `npm run build`는 웹과 MCP 전체 빌드, `npm run build:web`은 웹만, `npm run build:mcp`는 MCP만 빌드한다.
47
+
48
+ 저장소 루트에서 다음 명령으로 배포 파일을 검증할 수 있다. 실행 파일·이 문서·LICENSE·패키지 메타데이터 4개만 포함하는지 검사하고, tarball을 임시 경로에 설치해 도구 목록과 모든 기법·프롬프트 원문을 대조한다. 설치에는 npm 레지스트리 연결이 필요하다. 최종 tarball 경로를 출력하며, 임시 설치 폴더는 정리한다.
49
+
50
+ ```sh
51
+ npm run check:package
52
+ ```
53
+
54
+ 공개 게시가 완료된 버전은 MCP 클라이언트에서 `npx` 실행 파일과 `-y`, `@keke1933/vibe-dictionary-mcp@<게시된 버전>` 인수로 실행할 수 있다. 예를 들어 터미널 실행 명령은 `npx -y @keke1933/vibe-dictionary-mcp@0.1.0`이다. 실제 게시 전에는 이 명령으로 패키지를 받을 수 없다. 클라이언트의 실행 파일 검색 방식과 Windows의 `.cmd` 처리에 맞춰 설정한다.
55
+
56
+ 저장소 관리자는 GitHub Actions의 `Publish MCP to npm`을 `master`에서 수동 실행한다. 입력한 버전은 이미 커밋된 MCP 버전과 같아야 하며, GitHub `npm` environment와 npm Trusted Publisher를 사전에 설정한다. 최초 1회 패키지 생성·2FA 게시와 설정값은 저장소의 `docs/npm-publishing.md`를 참고한다. npm 토큰을 GitHub Secrets에 추가할 필요는 없다.
57
+
58
+ ## 라이선스
59
+
60
+ MCP 코드와 번들에 포함된 기법 데이터·프롬프트는 [MIT License](LICENSE)를 따른다. 제3자 의존성은 각각의 라이선스를 따른다.
61
+
62
+ 연결 방식의 근거: [MCP 공식 SDK](https://ts.sdk.modelcontextprotocol.io/server), [Codex 공식 MCP 문서](https://developers.openai.com/codex/mcp).
package/dist/index.js CHANGED
@@ -1461,7 +1461,7 @@ function matchesSearch(item, query) {
1461
1461
  // package.json
1462
1462
  var package_default = {
1463
1463
  name: "@keke1933/vibe-dictionary-mcp",
1464
- version: "0.1.0",
1464
+ version: "0.1.1",
1465
1465
  license: "MIT",
1466
1466
  author: "leejh96",
1467
1467
  description: "Read-only local MCP for searching Vibe Dictionary techniques and retrieving implementation prompts",
package/package.json CHANGED
@@ -1,41 +1,41 @@
1
- {
2
- "name": "@keke1933/vibe-dictionary-mcp",
3
- "version": "0.1.0",
4
- "license": "MIT",
5
- "author": "leejh96",
6
- "description": "Read-only local MCP for searching Vibe Dictionary techniques and retrieving implementation prompts",
7
- "type": "module",
8
- "repository": {
9
- "type": "git",
10
- "url": "git+https://github.com/leejh96/vibe-dictionary.git",
11
- "directory": "apps/mcp"
12
- },
13
- "homepage": "https://leejh96.github.io/vibe-dictionary/",
14
- "bugs": "https://github.com/leejh96/vibe-dictionary/issues",
15
- "keywords": ["mcp", "model-context-protocol", "ui", "prompts", "vibe-coding"],
16
- "publishConfig": {
17
- "access": "public",
18
- "registry": "https://registry.npmjs.org/"
19
- },
20
- "bin": {
21
- "vibe-dictionary-mcp": "dist/index.js"
22
- },
23
- "files": ["dist/index.js", "README.md", "LICENSE"],
24
- "engines": {
25
- "node": ">=22.12.0"
26
- },
27
- "scripts": {
28
- "build": "tsc --noEmit && esbuild src/index.ts --bundle --platform=node --format=esm --target=node22 --external:@modelcontextprotocol/sdk --external:zod --outfile=dist/index.js",
29
- "test": "npm run build && node --import tsx --test tests/*.test.ts",
30
- "start": "node dist/index.js",
31
- "prepack": "npm run build"
32
- },
33
- "dependencies": {
34
- "@modelcontextprotocol/sdk": "1.32.1",
35
- "zod": "4.6.7"
36
- },
37
- "devDependencies": {
38
- "@vibe-dictionary/catalog": "0.1.0",
39
- "esbuild": "0.28.2"
40
- }
41
- }
1
+ {
2
+ "name": "@keke1933/vibe-dictionary-mcp",
3
+ "version": "0.1.1",
4
+ "license": "MIT",
5
+ "author": "leejh96",
6
+ "description": "Read-only local MCP for searching Vibe Dictionary techniques and retrieving implementation prompts",
7
+ "type": "module",
8
+ "repository": {
9
+ "type": "git",
10
+ "url": "git+https://github.com/leejh96/vibe-dictionary.git",
11
+ "directory": "apps/mcp"
12
+ },
13
+ "homepage": "https://leejh96.github.io/vibe-dictionary/",
14
+ "bugs": "https://github.com/leejh96/vibe-dictionary/issues",
15
+ "keywords": ["mcp", "model-context-protocol", "ui", "prompts", "vibe-coding"],
16
+ "publishConfig": {
17
+ "access": "public",
18
+ "registry": "https://registry.npmjs.org/"
19
+ },
20
+ "bin": {
21
+ "vibe-dictionary-mcp": "dist/index.js"
22
+ },
23
+ "files": ["dist/index.js", "README.md", "LICENSE"],
24
+ "engines": {
25
+ "node": ">=22.12.0"
26
+ },
27
+ "scripts": {
28
+ "build": "tsc --noEmit && esbuild src/index.ts --bundle --platform=node --format=esm --target=node22 --external:@modelcontextprotocol/sdk --external:zod --outfile=dist/index.js",
29
+ "test": "npm run build && node --import tsx --test tests/*.test.ts",
30
+ "start": "node dist/index.js",
31
+ "prepack": "npm run build"
32
+ },
33
+ "dependencies": {
34
+ "@modelcontextprotocol/sdk": "1.32.1",
35
+ "zod": "4.6.7"
36
+ },
37
+ "devDependencies": {
38
+ "@vibe-dictionary/catalog": "0.1.0",
39
+ "esbuild": "0.28.2"
40
+ }
41
+ }