Skip to content

Commit d33176f

Browse files
committed
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.
1 parent 8bbade5 commit d33176f

4 files changed

Lines changed: 844 additions & 971 deletions

File tree

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

Lines changed: 47 additions & 13 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
@@ -153,38 +187,38 @@ jobs:
153187
# Fetch latest branches
154188
git fetch origin develop:refs/remotes/origin/develop
155189
git fetch origin main:refs/remotes/origin/main
156-
190+
157191
# Checkout develop
158192
git checkout -B develop origin/develop
159-
193+
160194
# Try to merge main
161195
if git merge origin/main -m "chore: back-merge main to develop after v${{ steps.get-version.outputs.version }} release" --no-edit; then
162196
echo "✅ Merge successful"
163197
# Push to develop
164198
git push origin develop
165199
else
166200
echo "⚠️ Merge conflicts detected. Creating a PR for manual resolution."
167-
201+
168202
# Create a branch for the back-merge
169203
BACKMERGE_BRANCH="backmerge/v${{ steps.get-version.outputs.version }}-to-develop"
170204
git checkout -b "$BACKMERGE_BRANCH"
171-
205+
172206
# Stage any resolved files (in case of partial auto-resolution)
173207
git add -A
174-
208+
175209
# Commit with conflicts markers if any
176210
git commit -m "chore: back-merge main to develop after v${{ steps.get-version.outputs.version }} release (with conflicts)" || true
177-
211+
178212
# Push the branch
179213
git push origin "$BACKMERGE_BRANCH"
180-
214+
181215
# Create a PR for manual resolution
182216
gh pr create \
183217
--title "Back-merge: v${{ steps.get-version.outputs.version }} from main to develop" \
184218
--body "This PR back-merges the changes from the v${{ steps.get-version.outputs.version }} release into develop.
185-
219+
186220
⚠️ **Merge conflicts were detected and need manual resolution.**
187-
221+
188222
Please review and resolve any conflicts before merging." \
189223
--base develop \
190224
--head "$BACKMERGE_BRANCH" \

0 commit comments

Comments
 (0)