Skip to content

Commit 01063a5

Browse files
github-actions[bot]AbdallahAHOsmithery[bot]
authored
Release v1.0.4 (#15)
* chore: add .npmignore for cleaner npm package * chore(package): update bin path and repository url syntax Add the .claude directory to npm ignore to exclude development files. Improve package.json metadata by correcting repository URL format to use the git+ protocol and adjusting the CLI binary path to avoid a leading relative path indicator, ensuring better compatibility with package tools. * feat: implement automated release workflow - Add master release workflow triggered from develop branch - Integrate DXT packaging into main CI workflow - Remove redundant release-dxt.yml workflow - Update semantic-release config to disable npm publishing - Add comprehensive release documentation with secrets guide - Implement full GitFlow automation with back-merging This allows contributors to release new versions with a single workflow trigger from the develop branch. The process automatically: 1. Creates release branch with version updates 2. Opens PR to main 3. After merge: publishes to npm, creates GitHub release with DXT 4. Back-merges to develop * feat: extend CI workflow to run on every push to main branches - Rename workflow to ci-code-quality.yml - Run on both pull requests AND pushes to main/develop - Adjust PR-specific features to only run on PRs - Update summaries to reflect branch vs PR context This ensures code quality on all commits to protected branches. * chore: add missing newline at end of config file * fix: add workflow permissions and create CHANGELOG.md - Add explicit permissions for contents and pull-requests in release workflow - Create initial CHANGELOG.md for version tracking - Fix 403 error when creating PRs from GitHub Actions * feat: add pre-commit hooks for formatting and linting - Configure husky to run pre-commit hooks - Add lint-staged to run biome format and lint on staged files - Ensures code quality before commits * fix: update release workflow to handle GitHub Actions PR permissions - Add support for GH_PAT as alternative to repository permissions - Document required GitHub repository settings in RELEASING.md - Add troubleshooting for 403 PR creation errors - Fix lint-staged to only process supported file types * fix: use GitHub CLI for PR creation to avoid permissions issue - Replace github-script with gh CLI for more reliable PR creation - Update documentation for fine-grained token permissions - Add pull request write permission requirement * chore: remove redundant source file ignores from ignore configs Remove obsolete ignore rules for source and script directories in ignore files to simplify project configuration and avoid conflicts with actual publishing logic. This clarifies which files are included during packaging and syncing, ensuring ignore files remain minimal and accurate. * ci: use environment vars for signing certificates Modify the CI workflow to pass signing certificates via environment variables instead of referencing secrets directly in the script. This improves readability and consistency in handling sensitive data during the release process. Minor whitespace cleanups and formatting adjustments are also included for better maintainability. * ci: update dxt command and remove signature verification Replace signature verification step with cleaning the package in the CI workflow to streamline the process. Remove redundant signature verification from the signing script to simplify signing and reduce failure points. Delete the now-unused `.dxtignore` file that listed excluded files for the DXT package. * refactor(logger): defer logger initialization and file setup Improve startup performance and avoid module-level side effects by lazily initializing loggers and deferring log file creation until the first log event. Streamline logger initialization by centralizing file logging setup and replacing synchronous early setup with on-demand initialization. This enhances reliability and reduces unnecessary I/O during import phases. Also apply lazy logger instantiation to domain-related modules for consistent behavior and safer side effect management. * Deployment: Dockerfile and Smithery config (#6) This PR adds files for deploying your MCP server on Smithery. After deployment, users can use your server over streamable HTTP (hosted on [Smithery](https://smithery.ai)) without needing to install any dependencies. ### Changes - Added **Dockerfile** to package your server for deployment. - Added **Smithery Configuration** file to specify how to start your server. See [documentation](https://smithery.ai/docs/build/deployments). - Updated **README** to include installation command via Smithery. _Note that the command only works after the server is deployed on Smithery._ ### Server Details - **Smithery ID**: `@AbdallahAHO/lokalise-mcp` - **Server Homepage**: [https://smithery.ai/server/@AbdallahAHO/lokalise-mcp](https://smithery.ai/server/@AbdallahAHO/lokalise-mcp?utm_campaign=pr&modal=claim) ### Action Items - [X] **Build Passing**: We verified that the Docker builds and your server starts up using an automated test. - [ ] **Code Review**: Please review the changes to ensure the configuration is accurate for your server. *These files were automatically generated and tested by Smithery* --------- Co-authored-by: smithery-ai[bot] <194235850+smithery-ai[bot]@users.noreply.github.com> * Update smithery.yaml * feat(config): add MCP initialization config handling and prioritization (#12) Introduce a handler extracting configuration from MCP client info during initialization, enabling dynamic config setup based on client-provided data. Update configuration loader to prioritize MCP init config over environment variables and other sources, ensuring runtime flexibility and seamless integration with MCP clients. Add comprehensive tests verifying MCP config precedence, boolean parsing, nested config handling, and hostname extraction. * ci: improve back-merge handling in release workflow - Add proper error handling for merge conflicts - Create PR automatically if conflicts occur - Use proper git fetch and checkout commands - Add GH_TOKEN for PR creation * refactor: reorder exports to improve consistency Adjust export statements in the transport module to maintain consistent ordering and grouping. Also tidy up import order in several modules for improved readability and alphabetical consistency, such as reordering imports in the contributors service and keys controller. These changes focus on code style and maintainability without affecting runtime behavior. * feat(usergroups): add complete user group management domain Implement full user groups management including CLI commands, MCP tools, and MCP resources to enable listing, retrieving, creating, updating, deleting, and managing members and projects within user groups. - Introduce domain exports and types with comprehensive Zod validation schemas - Add controller layer handling input validation, error processing, and formatting - Build service layer interfacing with Lokalise User Groups API for actual data operations - Create detailed Markdown formatters for human-readable output of API responses - Provide CLI commands for seamless command-line interaction and automation - Register MCP tools exposing user group operations to the MCP server - Register MCP resources enabling resource-based access to user groups via URI schemes This modular setup establishes a robust user groups domain supporting team-based permission management and integration with Lokalise platform workflows. * feat(teamusers): add domain with CLI, service, controller, formatter, and MCP tools Introduce a new domain for managing Lokalise team users including: - CLI commands for listing, retrieving, updating, and deleting team users. - Controller layer with validation and error handling. - Service layer integrating Lokalise API for team user operations. - Formatting of responses into readable markdown. - MCP resource and tool registration supporting API and interactive usage. Establishes a foundation for consistent and extensible team user management within the system. * feat(queuedprocesses): add domain for monitoring async operations Introduce a new queuedprocesses domain to support tracking and managing background asynchronous processes within Lokalise projects. This includes: - CLI commands for listing and retrieving queued process details with validation - Controller layer for input validation, error handling, and response formatting - Rich Markdown formatters presenting process status, details, and summaries - Service layer encapsulating API communication with Lokalise SDK - MCP resources enabling resource-based access to queued processes data - Tools integration for MCP server with typed argument schemas and error handling - Comprehensive TypeScript types and guards aligned with Lokalise SDK v9.0.0+ This domain provides a structured and user-friendly way to monitor various async tasks such as file uploads, downloads, project imports/exports, improving observability and operational control. Closes #N/A * refactor(prompts): expand and restructure MCP prompts with detailed schemas Rebuilds the MCP prompt registration to provide comprehensive, structured workflows for Lokalise operations using explicit, XML-like instructions aligned with Claude 4 best practices. - Replaces previous prompts with extensively detailed prompts covering project management, language localization, key management, tasks, workflows, team collaboration, compliance, and advanced workflows. - Introduces strict Zod schemas defining argument validation and user-friendly parameter naming to improve usability and robustness. - Enhances prompt guidance with stepwise instructions, context, and output formats to standardize responses and improve clarity. - Enables parallel execution hints and comprehensive analysis steps for efficiency and thorough reporting. - Adds new complex workflows including file upload review, team onboarding, automated review pipelines, process monitoring, and translation memory import. This refactor significantly improves maintainability, clarity, and feature coverage of prompts, setting a foundation for scalable, user-friendly automation workflows within the MCP environment. * feat(prompts): add workflows for post-upload and document extraction reviews Introduce two new review workflows to improve translation task management: - Add post-upload review workflow enabling creation of language-specific review tasks for files already uploaded to the platform with flexible assignee mapping and optional confirmation prior to task creation. - Add document extraction review workflow that parses raw document content into translation keys, creates them in bulk, and sets up translation tasks with language-based assignee assignments. Additionally, enhance key listing functionality by supporting filename-based filtering to precisely select keys associated with specific files, improving task scope accuracy. These additions streamline review and translation setup processes for files and document content, reducing manual overhead and enhancing assignment flexibility. * docs: update documentation Provides a detailed, code-verified guide summarizing full MCP server capabilities including 11 completed domains, 59 tools, 21 resources, and 17 workflow prompts. Enhances project documentation with updated architecture, usage examples, domain interfaces, and best practices to support scalable development and onboarding. Updates metadata and readme to reflect latest feature set and expanded domain coverage. * chore(release): prepare release v1.0.4 --------- Co-authored-by: Abdallah Othman <abdallah.ali.hassan@gmail.com> Co-authored-by: smithery-ai[bot] <194235850+smithery-ai[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 79bd0b7 commit 01063a5

40 files changed

Lines changed: 7514 additions & 1475 deletions

.github/workflows/ci-semantic-release.yml

Lines changed: 77 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -129,12 +129,46 @@ jobs:
129129
130130
### 📦 Installation
131131
132-
#### Desktop Extension (Recommended)
133-
Download and double-click `lokalise-mcp-${{ steps.get-version.outputs.version }}.dxt` to install in Claude Desktop.
132+
#### 1) Smithery (Recommended)
133+
Automated install and configuration for popular MCP clients.
134134
135-
#### npm Package
136135
```bash
137-
npm install -g lokalise-mcp@${{ steps.get-version.outputs.version }}
136+
# Claude Desktop
137+
npx -y @smithery/cli install @AbdallahAHO/lokalise-mcp --client claude
138+
139+
# Cursor
140+
npx -y @smithery/cli install @AbdallahAHO/lokalise-mcp --client cursor
141+
142+
# VS Code (Claude Code)
143+
npx -y @smithery/cli install @AbdallahAHO/lokalise-mcp --client vscode
144+
145+
# Claude Code
146+
claude mcp add --transport http abdallah-aho-lokalise-mcp "https://server.smithery.ai/@AbdallahAHO/lokalise-mcp/mcp"
147+
148+
# Gemini CLI
149+
npx -y @smithery/cli install @AbdallahAHO/lokalise-mcp --client gemini
150+
```
151+
152+
Inspect tools before installing:
153+
154+
```bash
155+
npx -y @smithery/cli@latest inspect @AbdallahAHO/lokalise-mcp
156+
```
157+
158+
#### 2) Claude Desktop Extension (DXT)
159+
Download and double-click `lokalise-mcp-${{ steps.get-version.outputs.version }}.dxt` to install in ClaudeDesktop.
160+
When prompted, enter your `LOKALISE_API_KEY`. Updates by installing the newer `.dxt`.
161+
162+
#### 3) Local (clone + run)
163+
```bash
164+
git clone https://github.com/AbdallahAHO/lokalise-mcp.git
165+
cd lokalise-mcp
166+
npm install
167+
168+
export LOKALISE_API_KEY="your-api-key-here"
169+
npm run mcp:http # HTTP (SSE) at http://localhost:3000/mcp
170+
# or
171+
npm run mcp:stdio # STDIO
138172
```
139173
140174
### 🔐 Verify Downloads
@@ -147,18 +181,49 @@ jobs:
147181
148182
# Step 11: Back-merge to develop
149183
- name: Back-merge to develop
184+
env:
185+
GH_TOKEN: ${{ secrets.GH_PAT || secrets.GITHUB_TOKEN }}
150186
run: |
151-
# Fetch latest develop
152-
git fetch origin develop:develop
187+
# Fetch latest branches
188+
git fetch origin develop:refs/remotes/origin/develop
189+
git fetch origin main:refs/remotes/origin/main
153190
154191
# Checkout develop
155-
git checkout develop
192+
git checkout -B develop origin/develop
193+
194+
# Try to merge main
195+
if git merge origin/main -m "chore: back-merge main to develop after v${{ steps.get-version.outputs.version }} release" --no-edit; then
196+
echo "✅ Merge successful"
197+
# Push to develop
198+
git push origin develop
199+
else
200+
echo "⚠️ Merge conflicts detected. Creating a PR for manual resolution."
201+
202+
# Create a branch for the back-merge
203+
BACKMERGE_BRANCH="backmerge/v${{ steps.get-version.outputs.version }}-to-develop"
204+
git checkout -b "$BACKMERGE_BRANCH"
156205
157-
# Merge main
158-
git merge main -m "chore: back-merge main to develop after v${{ steps.get-version.outputs.version }} release"
206+
# Stage any resolved files (in case of partial auto-resolution)
207+
git add -A
159208
160-
# Push to develop
161-
git push origin develop
209+
# Commit with conflicts markers if any
210+
git commit -m "chore: back-merge main to develop after v${{ steps.get-version.outputs.version }} release (with conflicts)" || true
211+
212+
# Push the branch
213+
git push origin "$BACKMERGE_BRANCH"
214+
215+
# Create a PR for manual resolution
216+
gh pr create \
217+
--title "Back-merge: v${{ steps.get-version.outputs.version }} from main to develop" \
218+
--body "This PR back-merges the changes from the v${{ steps.get-version.outputs.version }} release into develop.
219+
220+
⚠️ **Merge conflicts were detected and need manual resolution.**
221+
222+
Please review and resolve any conflicts before merging." \
223+
--base develop \
224+
--head "$BACKMERGE_BRANCH" \
225+
--repo ${{ github.repository }} || echo "PR creation failed, please create manually"
226+
fi
162227
163228
# Step 12: Summary
164229
- name: Release Summary
@@ -168,7 +233,7 @@ jobs:
168233
echo "- **Version**: ${{ steps.get-version.outputs.version }}" >> $GITHUB_STEP_SUMMARY
169234
echo "- **npm Published**: ${{ steps.npm-publish.outputs.published }}" >> $GITHUB_STEP_SUMMARY
170235
echo "- **GitHub Release**: ✅" >> $GITHUB_STEP_SUMMARY
171-
echo "- **Back-merged to develop**: " >> $GITHUB_STEP_SUMMARY
236+
echo "- **Back-merge Status**: Check workflow logs" >> $GITHUB_STEP_SUMMARY
172237
echo "" >> $GITHUB_STEP_SUMMARY
173238
echo "### 📋 Release Assets" >> $GITHUB_STEP_SUMMARY
174239
echo '```' >> $GITHUB_STEP_SUMMARY

CHANGELOG.md

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,49 @@
1-
# Changelog
1+
## [1.0.4] - 2025-08-11
2+
3+
### Added
4+
- **Queued Processes Domain** (2 tools + 1 resource): Monitor and manage asynchronous operations
5+
- `lokalise_list_queued_processes` - List all queued processes with filtering
6+
- `lokalise_get_queued_process` - Get detailed status of specific processes
7+
- Resource: `lokalise-queued-processes` for process monitoring
8+
- **Team Users Domain** (4 tools + 2 resources): Comprehensive team member management
9+
- `lokalise_list_team_users` - List all team users with pagination
10+
- `lokalise_get_team_user` - Get detailed user information
11+
- `lokalise_update_team_user` - Update user role and permissions
12+
- `lokalise_delete_team_user` - Remove users from team
13+
- Resources: `lokalise-team-users` (collection) and `lokalise-team-user-details` (individual)
14+
- **User Groups Domain** (9 tools + 2 resources): Advanced group-based permission management
15+
- `lokalise_list_usergroups` - List all user groups in team
16+
- `lokalise_get_usergroup` - Get group details with members and projects
17+
- `lokalise_create_usergroup` - Create new permission groups
18+
- `lokalise_update_usergroup` - Update group settings and permissions
19+
- `lokalise_delete_usergroup` - Remove user groups
20+
- `lokalise_add_members_to_group` - Add team members to groups
21+
- `lokalise_remove_members_from_group` - Remove members from groups
22+
- `lokalise_add_projects_to_group` - Assign projects to groups
23+
- `lokalise_remove_projects_from_group` - Unassign projects from groups
24+
- Resources: `lokalise-usergroups` (collection) and `lokalise-usergroup-details` (individual)
25+
- **Enhanced MCP Prompts System**: Comprehensive workflow prompts for AI assistants
26+
- Post-upload validation workflows for translation file imports
27+
- Document extraction review workflows for content verification
28+
- Expanded prompt schemas with detailed type definitions
29+
- Structured workflow templates for common localization tasks
30+
31+
### Changed
32+
- **MCP Prompts Architecture**: Complete restructure with detailed schemas and validation
33+
- Added 700+ lines of type definitions for better type safety
34+
- Expanded prompt templates from basic to comprehensive workflows
35+
- Improved prompt organization with clear separation of concerns
36+
- **Documentation Updates**: Enhanced README and CLAUDE.md with latest features
37+
38+
### Fixed
39+
- Export ordering consistency across domain modules
40+
41+
### Developer Experience
42+
- Total MCP tools increased from 39 to **54 tools** (+15)
43+
- Total MCP resources increased from 16 to **21 resources** (+5)
44+
- Enhanced auto-discovery system seamlessly integrates new domains
45+
- Maintained 100% backward compatibility with existing integrations
46+
247

348
All notable changes to this project will be documented in this file.
449

@@ -89,6 +134,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
89134
- Commander.js for CLI framework
90135
- ES modules with Node.js >=18.0.0 requirement
91136

137+
[1.0.4]: https://github.com/AbdallahAHO/lokalise-mcp/compare/v1.0.3...v1.0.4
92138
[1.0.3]: https://github.com/AbdallahAHO/lokalise-mcp/compare/v1.0.2...v1.0.3
93139
[1.0.2]: https://github.com/AbdallahAHO/lokalise-mcp/compare/v1.0.1...v1.0.2
94140
[1.0.1]: https://github.com/AbdallahAHO/lokalise-mcp/compare/v1.0.0...v1.0.1

0 commit comments

Comments
 (0)