@p1kka/simplelocalize
v1.0.2
Published
MCP server for SimpleLocalize integration
Downloads
4
Maintainers
Readme
@p1kka/simplelocalize
A Model Context Protocol (MCP) server for SimpleLocalize integration, enabling AI assistants to interact with translation and localization workflows.
Features
- Translation Management: Access and manage translation keys and values
- Language Support: Work with multiple languages and locales
- Project Integration: Connect to SimpleLocalize projects via API
- MCP Compliance: Full Model Context Protocol implementation
Installation
npm install @p1kka/simplelocalizeUsage
As a CLI tool
npx @p1kka/simplelocalizeAs an MCP server
This package can be used as an MCP server in AI assistant applications that support the Model Context Protocol.
Configuration
The MCP server requires SimpleLocalize API credentials to function. Configure your environment with:
export SIMPLELOCALIZE_API_KEY="your-api-key"
export SIMPLELOCALIZE_PROJECT_ID="your-project-id"MCP Server Configuration
To use this package as an MCP server in your AI assistant application, you need to configure it in your MCP client settings.
Basic Configuration
Add the following configuration to your MCP client's configuration file:
{
"mcpServers": {
"simplelocalize": {
"command": "npx",
"args": ["@p1kka/simplelocalize"],
"env": {
"SIMPLELOCALIZE_API_KEY": "your-api-key-here",
"SIMPLELOCALIZE_PROJECT_ID": "your-project-id-here"
}
}
}
}Configuration Options
- command: The command to run the MCP server (typically
npx) - args: Array of arguments for the command (the package name)
- env: Environment variables required by the server
SIMPLELOCALIZE_API_KEY: Your SimpleLocalize API keySIMPLELOCALIZE_PROJECT_ID: Your SimpleLocalize project ID
API Reference
Functions
getTranslationKeys()- Retrieve all translation keys from the projectgetTranslations(language)- Get translations for a specific languageupdateTranslation(key, language, value)- Update a translation valueaddTranslationKey(key, translations)- Add a new translation key
Development
Prerequisites
- Node.js 18.0.0 or higher
- pnpm package manager
Setup
# Install dependencies
pnpm install
# Build the project
pnpm build
# Run in development mode
pnpm devScripts
pnpm build- Build the TypeScript projectpnpm dev- Run in development mode with hot reloadpnpm start- Run the built applicationpnpm lint- Run ESLintpnpm format- Format code with Prettier
License
ISC
Author
Jose Giovanni Vargas Rueda
Repository
- GitHub: p1kka/simplelocalize-mcp
- Issues: GitHub Issues
