Weblate MCP Server

Instructions

Implementation Reference

• src/tools/statistics.tool.ts:49-87 (handler)

  Primary handler decorated with @Tool decorator. Defines input schema, fetches statistics from service, formats response as markdown text, and handles errors.

  @Tool({
    name: 'getComponentStatistics',
    description: 'Get detailed statistics for a specific component',
    parameters: z.object({
      projectSlug: z.string().describe('The slug of the project'),
      componentSlug: z.string().describe('The slug of the component'),
    }),
  })
  async getComponentStatistics({
    projectSlug,
    componentSlug,
  }: {
    projectSlug: string;
    componentSlug: string;
  }) {
    try {
      const stats = await this.statisticsService.getComponentStatistics(projectSlug, componentSlug);
  
      return {
        content: [
          {
            type: 'text',
            text: this.formatComponentStatistics(projectSlug, componentSlug, stats),
          },
        ],
      };
    } catch (error) {
      this.logger.error(`Failed to get component statistics for ${projectSlug}/${componentSlug}`, error);
      return {
        content: [
          {
            type: 'text',
            text: `Error getting component statistics: ${error.message}`,
          },
        ],
        isError: true,
      };
    }
  }

• src/tools/statistics.tool.ts:52-55 (schema)

  Zod schema for input parameters: projectSlug and componentSlug.

  parameters: z.object({
    projectSlug: z.string().describe('The slug of the project'),
    componentSlug: z.string().describe('The slug of the component'),
  }),

• src/app.module.ts:78-80 (registration)

  The WeblateStatisticsTool is registered as a provider in the AppModule, enabling its tools to be available via MCP.

    WeblateChangesTool,
    WeblateStatisticsTool,
  ],

• src/services/weblate/statistics.service.ts:48-68 (helper)

  Service method that retrieves raw component statistics from Weblate API using componentsStatisticsRetrieve.

  async getComponentStatistics(projectSlug: string, componentSlug: string) {
    try {
      const response = await componentsStatisticsRetrieve({
        client: this.clientService.getClient(),
        path: { 
          project__slug: projectSlug,
          slug: componentSlug 
        },
        query: { format: 'json' },
      });
  
      if (response.error) {
        throw new Error(`Failed to get component statistics: ${response.error}`);
      }
  
      return response.data;
    } catch (error) {
      this.logger.error(`Failed to get component statistics for ${projectSlug}/${componentSlug}`, error);
      throw error;
    }
  }

• src/tools/statistics.tool.ts:313-341 (helper)

  Utility method to format the raw statistics data into a readable markdown string for the tool response.

    private formatComponentStatistics(projectSlug: string, componentSlug: string, stats: any): string {
      const getStatValue = (key: string, defaultValue = 'N/A') => {
        return stats?.[key] !== undefined ? stats[key] : defaultValue;
      };
  
      const formatPercent = (value: any) => {
        return typeof value === 'number' ? `${value.toFixed(1)}%` : 'N/A';
      };
  
      return `## 📊 Component Statistics: ${stats?.name || componentSlug}
  
  **Project:** ${projectSlug}
  **Component:** ${componentSlug}
  
  **Translation Progress:**
  - 🎯 Translated: ${formatPercent(getStatValue('translated_percent'))}
  - ✅ Approved: ${formatPercent(getStatValue('approved_percent'))}
  - 🔍 Needs Review: ${formatPercent(getStatValue('readonly_percent'))}
  - ❌ Untranslated: ${formatPercent(getStatValue('nottranslated_percent'))}
  
  **String Counts:**
  - 📝 Total: ${getStatValue('total')}
  - ✅ Translated: ${getStatValue('translated')}
  - 🎯 Approved: ${getStatValue('approved')}
  - ❌ Untranslated: ${getStatValue('nottranslated')}
  
  **Component Details:**
  - 🌐 URL: ${stats?.web_url || 'N/A'}
  - 📁 Source Language: ${stats?.source_language?.name || 'N/A'} (${stats?.source_language?.code || 'N/A'})`;