Freshservice

Interaja com os módulos do Freshservice para operações de gerenciamento de serviços de TI.

Documentação

Freshservice MCP Server

smithery badge

Visão Geral

Uma implementação poderosa de servidor MCP (Model Context Protocol) que se integra perfeitamente ao Freshservice, permitindo que modelos de IA interajam com os módulos do Freshservice e executem diversas operações de gerenciamento de serviços de TI. Esta ponte de integração capacita seus assistentes de IA a gerenciar e resolver tickets de serviço de TI, otimizando seu fluxo de trabalho de suporte.

Principais Recursos

  • Integração Freshservice de Nível Empresarial: Comunicação direta e segura com os endpoints da API do Freshservice
  • Compatibilidade com Modelos de IA: Permite que Claude e outros modelos de IA executem operações de service desk através do Freshservice
  • Gerenciamento Automatizado de ITSM: Lida eficientemente com criação, atualização e respostas de tickets, além do gerenciamento de ativos
  • Aceleração do Fluxo de Trabalho: Reduz a intervenção manual em tarefas rotineiras de serviços de TI

Módulos Freshservice Suportados

Este servidor MCP atualmente suporta operações em uma ampla gama de módulos do Freshservice:

  • Tickets
  • Changes
  • Conversations
  • Products
  • Requesters
  • Agents
  • Agent Groups
  • Requester Groups
  • Canned Responses
  • Canned Response Folders
  • Workspaces
  • Solution Categories
  • Solution Folders
  • Solution Articles

Componentes e Ferramentas

O servidor fornece um kit de ferramentas abrangente para operações do Freshservice:

Gerenciamento de Tickets

FerramentaDescriçãoParâmetros Principais
create_ticketCriar novos tickets de serviçosubject, description, source, priority, status, email
update_ticketAtualizar tickets existentesticket_id, updates
delete_ticketRemover ticketsticket_id
filter_ticketsEncontrar tickets que correspondem aos critériosquery
get_ticket_fieldsRecuperar definições de campos de ticketsNenhum
get_ticketsListar todos os tickets com paginaçãopage, per_page
get_ticket_by_idRecuperar detalhes de um único ticketticket_id

Gerenciamento de Mudanças

FerramentaDescriçãoParâmetros Principais
get_changesListar todas as mudanças com paginaçãopage, per_page, query
filter_changesFiltrar mudanças com consultas avançadasquery, page, per_page
get_change_by_idRecuperar detalhes de uma única mudançachange_id
create_changeCriar nova solicitação de mudançarequester_id, subject, description, priority, impact, status, risk, change_type
update_changeAtualizar mudança existentechange_id, change_fields
close_changeFechar mudança com explicação do resultadochange_id, change_result_explanation
delete_changeRemover mudançachange_id
get_change_tasksObter tarefas de uma mudançachange_id
create_change_noteAdicionar nota à mudançachange_id, body

🚨 Importante: Sintaxe de Consulta para Filtragem

Ao usar get_changes ou filter_changes com o parâmetro query, a string de consulta deve estar entre aspas duplas para que a API do Freshservice funcione corretamente:

✅ CORRETO: "status:3", "approval_status:1 AND status:<6"
❌ ERRADO: status:3 (causará erro 500 Internal Server Error)

Exemplos Comuns de Consulta:

  • "status:3" - Mudanças aguardando aprovação
  • "approval_status:1" - Mudanças aprovadas
  • "approval_status:1 AND status:<6" - Mudanças aprovadas que não estão fechadas
  • "planned_start_date:>'2025-07-14'" - Mudanças iniciando após data específica
  • "status:3 AND priority:1" - Mudanças de alta prioridade aguardando aprovação

Começando

Instalação via Smithery

Para instalar o freshservice_mcp automaticamente via Smithery:

npx -y @smithery/cli install @effytech/freshservice_mcp --client claude

Pré-requisitos

  • Uma conta Freshservice (cadastre-se em freshservice.com)
  • Chave de API do Freshservice
  • uvx instalado (pip install uv ou brew install uv)

Configuração

  1. Gere sua chave de API do Freshservice no painel administrativo:

    • Navegue até Configurações de Perfil → Configurações de API
    • Copie sua chave de API para configuração
  2. Configure seu domínio e detalhes de autenticação conforme mostrado abaixo

Uso com Claude Desktop

  1. Instale o Claude Desktop no site oficial
  2. Adicione a seguinte configuração ao seu claude_desktop_config.json:
"mcpServers": {
  "freshservice-mcp": {
    "command": "uvx",
    "args": [
        "freshservice-mcp"
    ],
    "env": {
      "FRESHSERVICE_APIKEY": "<YOUR_FRESHSERVICE_APIKEY>",
      "FRESHSERVICE_DOMAIN": "<YOUR_FRESHSERVICE_DOMAIN>"
    }
  }
}

Importante: Substitua <YOUR_FRESHSERVICE_APIKEY> pela sua chave de API real e <YOUR_FRESHSERVICE_DOMAIN> pelo seu domínio (ex.: yourcompany.freshservice.com)

Exemplos de Operações

Após a configuração, você pode pedir ao Claude para executar operações como:

Tickets:

  • "Criar um novo ticket de incidente com o assunto 'Problema de conectividade de rede no departamento de Marketing' e descrição 'Usuários não conseguem se conectar ao Wi-Fi na área de Marketing', definir prioridade como alta"
  • "Listar todos os incidentes críticos relatados nas últimas 24 horas"
  • "Atualizar o status do ticket #12345 para resolvido"

Mudanças:

  • "Criar uma solicitação de mudança para manutenção programada do servidor na próxima terça-feira às 2h"
  • "Atualizar o status da solicitação de mudança #45678 para 'Aprovada'"
  • "Fechar a mudança #5092 com explicação do resultado 'Implantado com sucesso em produção. Todos os testes passaram.'"
  • "Listar todas as mudanças pendentes"

Outras Operações:

  • "Mostrar detalhes do ativo para o laptop com etiqueta de ativo 'LT-2023-087'"
  • "Criar um artigo de solução sobre procedimentos de redefinição de senha"

Testes

Para fins de teste, você pode iniciar o servidor manualmente:

uvx freshservice-mcp --env FRESHSERVICE_APIKEY=<your_api_key> --env FRESHSERVICE_DOMAIN=<your_domain>

Solução de Problemas

  • Verifique se sua chave de API e domínio do Freshservice estão corretos
  • Garanta conectividade de rede adequada aos servidores do Freshservice
  • Verifique os limites de taxa e cotas da API
  • Verifique se o comando uvx está disponível no seu PATH

Licença

Este servidor MCP é licenciado sob a Licença MIT. Consulte o arquivo LICENSE no repositório do projeto para obter detalhes completos.

Recursos Adicionais


Feito com ❤️ por effy