refactor: rename mcp-server to mcp and update references

tikazyq · tikazyq · commit 9cadf9e978d6 · 2025-06-24T23:19:37.000+08:00
- Updated package name from `@devlog/mcp-server` to `@devlog/mcp` across README, package.json, and documentation.
- Adjusted test commands and scripts to reflect the new package name.
- Created a new README.md for the `@devlog/mcp` package detailing its features and usage.
- Added mcp-adapter for flexible storage architecture and integrated it with the MCP server.
- Implemented core functionalities for managing devlogs, including creation, updates, and context management.
- Added integration tests for the MCP server to ensure functionality.
- Introduced AI context management features to enhance task tracking and decision recording.
- Updated TypeScript configuration and Vitest setup for the new package.
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md
@@ -23,7 +23,7 @@
 This project uses **itself** for development tracking. When working on devlog features, ALWAYS:
 
 ### 1. Use Devlog for All Development Work
-- Create devlog entries for new features, bugs, or improvements using `@devlog/mcp-server`
+- Create devlog entries for new features, bugs, or improvements using `@devlog/mcp`
 - Use `find_or_create_devlog` to prevent duplicates
 - Track progress with notes and status updates through the MCP server tools
 
@@ -68,8 +68,9 @@ This ensures the devlog system is continuously tested and improved through real-
 ## Testing Best Practices
 
 ### 1. Prefer Structured Tests Over Temporary Scripts
-- **Use Vitest framework**: Create proper test cases instead of ad-hoc scripts in `scripts/`
-- **Avoid temp scripts**: Don't create temporary `.mjs` files for testing functionality
+- **Use Vitest framework**: Create proper test cases instead of ad-hoc scripts for testing functionality
+- **Avoid temp scripts in tracked directories**: Don't create temporary `.mjs` files in `scripts/`, `src/`, or other tracked locations
+- **Use `tmp/` for debugging only**: When debugging or quick testing is needed, use the `tmp/` directory (gitignored)
 - **Comprehensive test coverage**: Write unit tests, integration tests, and end-to-end tests as needed
 - **Maintainable testing**: Tests should be part of the CI/CD pipeline and easily runnable
 - **Clean up legacy**: Remove temporary scripts once proper tests are in place
@@ -82,8 +83,14 @@ This ensures the devlog system is continuously tested and improved through real-
 - **Descriptive test names**: Tests should clearly describe what they're validating
 
 ### 3. Testing Workflow
-1. Identify functionality that needs testing
-2. Write appropriate test cases using Vitest
-3. Ensure tests can be run with standard npm/pnpm scripts
-4. Include tests in CI/CD pipeline
-5. Remove any temporary scripts that served the same purpose
+1. **Primary approach**: Write proper test cases using Vitest framework
+2. **For debugging only**: Use `tmp/` directory for temporary debugging scripts (gitignored)
+3. **Test organization**: Ensure tests can be run with standard npm/pnpm scripts
+4. **Cleanup**: Remove any temporary debugging files from `tmp/` when no longer needed
+5. **Structured over ad-hoc**: Always prefer structured tests over temporary scripts
+
+### 4. File Management for Testing
+- **Proper tests**: `packages/*/src/__tests__/` directories using Vitest
+- **Debugging files**: `tmp/` directory (temporary, gitignored)
+- **Never create**: Temporary scripts in `scripts/`, `src/`, or other tracked directories
+- **Clean codebase**: Keep the main codebase free of debugging artifacts
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -61,7 +61,7 @@ jobs:
       - name: Run integration tests
         run: pnpm test:integration
 
-  mcp-server-test:
+  mcp-test:
     runs-on: ubuntu-latest
     needs: test
     
@@ -92,25 +92,25 @@ jobs:
 
       - name: Verify MCP server binary
         run: |
-          ls -la packages/mcp-server/build/
-          [ -f "packages/mcp-server/build/index.js" ] || { echo "MCP server binary not found"; exit 1; }
-          [ -x "packages/mcp-server/build/index.js" ] || chmod +x "packages/mcp-server/build/index.js"
+          ls -la packages/mcp/build/
+          [ -f "packages/mcp/build/index.js" ] || { echo "MCP server binary not found"; exit 1; }
+          [ -x "packages/mcp/build/index.js" ] || chmod +x "packages/mcp/build/index.js"
 
       - name: Test MCP server startup
         run: |
-          cd packages/mcp-server
+          cd packages/mcp
           timeout 10s node build/index.js --help || echo "MCP server help command test completed"
           
       - name: Test MCP server with stdio transport
         run: |
-          cd packages/mcp-server
+          cd packages/mcp
           # Test that the server can start and respond to basic MCP protocol
           echo '{"jsonrpc": "2.0", "id": 1, "method": "initialize", "params": {"protocolVersion": "2024-11-05", "capabilities": {}, "clientInfo": {"name": "test-client", "version": "1.0.0"}}}' | timeout 10s node build/index.js || echo "MCP server protocol test completed"
 
       - name: Test MCP server functionality
         run: |
           # Run the integration test script that tests actual MCP server functionality
-          cd packages/mcp-server
+          cd packages/mcp
           node build/test.js
 
       - name: Run MCP protocol compliance tests
@@ -145,7 +145,7 @@ jobs:
       - name: Verify build artifacts
         run: |
           # Check that build artifacts exist
-          [ -f "packages/mcp-server/build/index.js" ] || { echo "MCP server build failed"; exit 1; }
+          [ -f "packages/mcp/build/index.js" ] || { echo "MCP server build failed"; exit 1; }
           [ -f "packages/types/build/index.js" ] || { echo "Types build failed"; exit 1; }
           [ -f "packages/types/build/index.d.ts" ] || { echo "Types declaration build failed"; exit 1; }
           [ -f "packages/core/build/index.js" ] || { echo "Core build failed"; exit 1; }
@@ -155,14 +155,14 @@ jobs:
       - name: Test package installation
         run: |
           # Test that packages can be packed
-          cd packages/mcp-server && npm pack
+          cd packages/mcp && npm pack
           cd ../types && npm pack
           cd ../core && npm pack
           echo "✅ All packages can be packed successfully!"
 
       - name: Test MCP server can be executed
         run: |
-          cd packages/mcp-server
+          cd packages/mcp
           chmod +x build/index.js
           # Test that the server binary is executable
           timeout 5s node build/index.js --version || echo "MCP server version check completed"
@@ -200,18 +200,18 @@ jobs:
       - name: Test MCP server startup (Unix)
         if: runner.os != 'Windows'
         run: |
-          cd packages/mcp-server
+          cd packages/mcp
           timeout 10s node build/index.js --help || echo "MCP server help test completed"
 
       - name: Test MCP server startup (Windows)
         if: runner.os == 'Windows'
         run: |
-          cd packages/mcp-server
+          cd packages/mcp
           # Windows doesn't have timeout, use PowerShell
           powershell -Command "Start-Process -FilePath 'node' -ArgumentList 'build/index.js', '--help' -Wait -TimeoutSec 10 -ErrorAction SilentlyContinue"
           echo "MCP server help test completed"
 
       - name: Run basic functionality test
         run: |
-          cd packages/mcp-server
+          cd packages/mcp
           node build/test.js
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -16,7 +16,7 @@ on:
           - minor
           - major
       packages:
-        description: 'Packages to publish (comma-separated: mcp-server,types or leave empty for all)'
+        description: 'Packages to publish (comma-separated: mcp,types or leave empty for all)'
         required: false
         type: string
 
@@ -93,7 +93,7 @@ jobs:
           if [ -n "${{ github.event.inputs.packages }}" ]; then
             PACKAGES="${{ github.event.inputs.packages }}"
           else
-            PACKAGES="mcp-server,types"
+            PACKAGES="mcp,types"
           fi
           echo "packages=$PACKAGES" >> $GITHUB_OUTPUT
 
@@ -103,8 +103,8 @@ jobs:
           IFS=',' read -ra PACKAGE_ARRAY <<< "${{ steps.packages.outputs.packages }}"
           for pkg in "${PACKAGE_ARRAY[@]}"; do
             pkg=$(echo "$pkg" | xargs) # trim whitespace
-            if [ "$pkg" == "mcp-server" ]; then
-              cd packages/mcp-server
+            if [ "$pkg" == "mcp" ]; then
+              cd packages/mcp
               npm version ${{ steps.version.outputs.version }} --no-git-tag-version
               cd ../..
             elif [ "$pkg" == "types" ]; then
@@ -120,8 +120,8 @@ jobs:
           IFS=',' read -ra PACKAGE_ARRAY <<< "${{ steps.packages.outputs.packages }}"
           for pkg in "${PACKAGE_ARRAY[@]}"; do
             pkg=$(echo "$pkg" | xargs) # trim whitespace
-            if [ "$pkg" == "mcp-server" ]; then
-              cd packages/mcp-server
+            if [ "$pkg" == "mcp" ]; then
+              cd packages/mcp
               npm version ${{ steps.version.outputs.version }} --no-git-tag-version --allow-same-version
               cd ../..
             elif [ "$pkg" == "types" ]; then
@@ -141,9 +141,9 @@ jobs:
           IFS=',' read -ra PACKAGE_ARRAY <<< "${{ steps.packages.outputs.packages }}"
           for pkg in "${PACKAGE_ARRAY[@]}"; do
             pkg=$(echo "$pkg" | xargs) # trim whitespace
-            if [ "$pkg" == "mcp-server" ]; then
-              echo "Publishing @devlog/mcp-server..."
-              cd packages/mcp-server
+            if [ "$pkg" == "mcp" ]; then
+              echo "Publishing @devlog/mcp..."
+              cd packages/mcp
               npm publish --access public
               cd ../..
             elif [ "$pkg" == "types" ]; then
@@ -175,7 +175,7 @@ jobs:
             Published packages: ${{ steps.packages.outputs.packages }}
             
             ### Packages
-            - @devlog/mcp-server@${{ steps.version.outputs.version }}
+            - @devlog/mcp@${{ steps.version.outputs.version }}
             - @devlog/types@${{ steps.version.outputs.version }}
           draft: false
           prerelease: false
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -83,7 +83,7 @@ jobs:
               NEW_VERSION=$(npm version ${{ github.event.inputs.release_type }} --no-git-tag-version)
               NEW_VERSION=${NEW_VERSION#v} # Remove 'v' prefix
               echo "mcp_new_version=$NEW_VERSION" >> $GITHUB_OUTPUT
-              NEW_VERSIONS="$NEW_VERSIONS@devlog/mcp-server@$NEW_VERSION "
+              NEW_VERSIONS="$NEW_VERSIONS@devlog/mcp@$NEW_VERSION "
               cd ../..
             elif [ "$pkg" == "types" ]; then
               cd packages/types
@@ -107,7 +107,7 @@ jobs:
           CHANGELOG="$CHANGELOG### Packages Updated\n"
           
           if [[ "${{ steps.bump_versions.outputs.packages }}" == *"mcp-server"* ]]; then
-            CHANGELOG="$CHANGELOG- **@devlog/mcp-server**: ${{ steps.current_versions.outputs.mcp_version }} → ${{ steps.bump_versions.outputs.mcp_new_version }}\n"
+            CHANGELOG="$CHANGELOG- **@devlog/mcp**: ${{ steps.current_versions.outputs.mcp_version }} → ${{ steps.bump_versions.outputs.mcp_new_version }}\n"
           fi
           
           if [[ "${{ steps.bump_versions.outputs.packages }}" == *"types"* ]]; then
@@ -153,7 +153,7 @@ jobs:
           for pkg in "${PACKAGE_ARRAY[@]}"; do
             pkg=$(echo "$pkg" | xargs) # trim whitespace
             if [ "$pkg" == "mcp-server" ]; then
-              echo "Publishing @devlog/mcp-server..."
+              echo "Publishing @devlog/mcp..."
               cd packages/mcp-server
               npm publish --access public
               cd ../..
diff --git a/.vscode/mcp.json b/.vscode/mcp.json
@@ -8,7 +8,7 @@
             "command": "pnpm",
             "args": [
                 "--filter",
-                "@devlog/mcp-server",
+                "@devlog/mcp",
                 "start"
             ]
         },
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -63,8 +63,8 @@ You can also work directly with individual packages using pnpm filters:
 
 ```bash
 # Work on the MCP server package
-pnpm --filter @devlog/mcp-server build
-pnpm --filter @devlog/mcp-server dev
+pnpm --filter @devlog/mcp build
+pnpm --filter @devlog/mcp dev
 
 # Work on the core package
 pnpm --filter @devlog/core build
@@ -75,7 +75,7 @@ pnpm --filter @devlog/types build
 pnpm --filter @devlog/types dev
 
 # Install dependencies for a specific package
-pnpm --filter @devlog/mcp-server add some-dependency
+pnpm --filter @devlog/mcp add some-dependency
 ```
 
 ## Adding New Packages
@@ -101,7 +101,7 @@ When adding a new package to the monorepo:
 
 - `@devlog/types`: Shared TypeScript types and interfaces
 - `@devlog/core`: Core devlog management functionality (file system operations, CRUD, etc.)
-- `@devlog/mcp-server`: MCP server implementation that wraps the core functionality
+- `@devlog/mcp`: MCP server implementation that wraps the core functionality
 - Future packages might include:
   - `@devlog/cli`: Command-line interface for devlog management
   - `@devlog/web`: Web interface for browsing devlogs
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ Shared TypeScript types and interfaces used across all packages.
 ### `@devlog/core` 
 Core devlog management functionality including file system operations, CRUD operations, filtering, and search. This package provides the foundation that other packages build upon.
 
-### `@devlog/mcp-server`
+### `@devlog/mcp`
 MCP (Model Context Protocol) server that wraps the core functionality for AI assistant integration.
 
 ## Features
diff --git a/docs/guides/TESTING.md b/docs/guides/TESTING.md
@@ -49,7 +49,7 @@ pnpm test:integration
 pnpm test
 
 # Run only MCP server tests
-pnpm --filter @devlog/mcp-server test
+pnpm --filter @devlog/mcp test
 ```
 
 ## 🔧 Manual Testing with MCP Client
diff --git a/package.json b/package.json
@@ -5,16 +5,16 @@
   "private": true,
   "scripts": {
     "build": "pnpm -r build",
-    "start": "pnpm --filter @devlog/mcp-server start",
-    "dev": "pnpm --filter @devlog/mcp-server dev",
+    "start": "pnpm --filter @devlog/mcp start",
+    "dev": "pnpm --filter @devlog/mcp dev",
     "test": "pnpm -r test",
     "test:watch": "pnpm -r test:watch",
-    "test:coverage": "pnpm --filter @devlog/mcp-server test -- --coverage",
-    "test:integration": "pnpm --filter @devlog/mcp-server test:integration",
+    "test:coverage": "pnpm --filter @devlog/mcp test -- --coverage",
+    "test:integration": "pnpm --filter @devlog/mcp test:integration",
     "test:mcp-compliance": "node scripts/test-mcp-compliance.mjs",
     "clean": "pnpm -r clean && rm -f *.tsbuildinfo",
     "install-all": "pnpm install",
-    "build:mcp": "pnpm --filter @devlog/mcp-server build",
+    "build:mcp": "pnpm --filter @devlog/mcp build",
     "build:types": "pnpm --filter @devlog/types build",
     "build:core": "pnpm --filter @devlog/core build",
     "build:web": "pnpm --filter @devlog/web build",
diff --git a/packages/core/README.md b/packages/core/README.md
@@ -121,7 +121,7 @@ Storage is configured through the `DevlogManager` constructor or environment var
 
 This core package is designed to be used by:
 
-- `@devlog/mcp-server` - MCP server for AI assistants
+- `@devlog/mcp` - MCP server for AI assistants
 - `@devlog/cli` - Command-line interface
 - `@devlog/web` - Web interface for browsing devlogs
 - Custom applications and scripts
diff --git a/packages/mcp/README.md b/packages/mcp/README.md
@@ -1,4 +1,4 @@
-# @devlog/mcp-server
+# @devlog/mcp
 
 Model Context Protocol (MCP) server for managing development logs and working notes.
 
diff --git a/packages/mcp/package.json b/packages/mcp/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@devlog/mcp-server",
+  "name": "@devlog/mcp",
   "version": "1.0.0",
   "description": "MCP server for managing development logs and working notes",
   "main": "build/index.js",
@@ -16,7 +16,7 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/your-username/devlog-monorepo.git",
-    "directory": "packages/mcp-server"
+    "directory": "packages/mcp"
   },
   "homepage": "https://github.com/your-username/devlog-monorepo#readme",
   "bugs": {
diff --git a/packages/mcp/src/__tests__/integration.test.ts b/packages/mcp/src/__tests__/integration.test.ts
diff --git a/packages/mcp/src/ai-context-demo.ts b/packages/mcp/src/ai-context-demo.ts
diff --git a/packages/mcp/src/index.ts b/packages/mcp/src/index.ts
diff --git a/packages/mcp/src/mcp-adapter.ts b/packages/mcp/src/mcp-adapter.ts
diff --git a/packages/mcp/tsconfig.json b/packages/mcp/tsconfig.json
diff --git a/packages/mcp/vitest.config.ts b/packages/mcp/vitest.config.ts
diff --git a/tsconfig.json b/tsconfig.json
@@ -22,7 +22,7 @@
   "references": [
     { "path": "./packages/types" },
     { "path": "./packages/core" },
-    { "path": "./packages/mcp-server" }
+    { "path": "./packages/mcp" }
   ],
   "files": [],
   "exclude": ["node_modules", "**/build", "**/dist"]

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`"command": "pnpm",`
`9`	`9`	`"args": [`
`10`	`10`	`"--filter",`
`11`		`- "@devlog/mcp-server",`
	`11`	`+ "@devlog/mcp",`
`12`	`12`	`"start"`
`13`	`13`	`]`
`14`	`14`	`},`