kintone Sample MCP Server

Integre com dados e aplicações do kintone usando o Model Context Protocol.

Documentação

Servidor MCP para kintone Exemplo (Não oficial)

Este é um servidor local MCP(Model Context Protocol) (código de exemplo) não oficial, que não é da Cybozu, que pode ser usado para integração com o kintone.

⚠️ Atenção: Este Servidor MCP não é oficial
Este Servidor MCP não é desenvolvido nem mantido pela Cybozu, fornecedora do kintone. É um projeto não oficial desenvolvido por um indivíduo. O uso é por sua conta e risco. O servidor MCP local oficial da Cybozu é publicado e distribuído em https://github.com/kintone/mcp-server.

Usando este servidor MCP local, você pode consultar e atualizar dados do kintone, criar aplicativos kintone, e muito mais, a partir de aplicativos de desktop que suportam MCP (hosts MCP), como o aplicativo Claude Desktop. Ele foi projetado para que o LLM possa lidar com o kintone sem problemas.

Procedimento de instalação no aplicativo Claude Desktop usando o arquivo mcpb (anteriormente com a extensão dxt) (recomendado)

Baixe o unofficial-kintone-mcp-server-8.1.0.mcpb mais recente de https://github.com/r3-yamauchi/kintone-mcp-server/releases e, no aplicativo Claude Desktop, clique em [Configurações] > [Aplicativos de desktop] > [Extensões].

Se a mensagem "Arraste e solte o arquivo .MCPB ou .DXT aqui para instalar" for exibida, arraste e solte o arquivo unofficial-kintone-mcp-server-8.1.0.mcpb baixado.

Se a mensagem "Arraste e solte o arquivo .MCPB ou .DXT aqui para instalar" não for exibida, clique em "Configurações avançadas" e depois em "Instalar extensão..." para selecionar o arquivo unofficial-kintone-mcp-server-8.1.0.mcpb baixado.

Clique em "Instalar".

Insira o domínio, o nome de usuário e a senha do kintone de destino e clique no botão "Salvar".

Clique no interruptor que está "Desativado" para "Ativá-lo" e feche a tela de configurações.

Abra uma nova tela de chat. Ao clicar no ícone de ferramentas, as extensões (servidores MCP) carregadas serão exibidas. Se "unofficial-kintone-mcp-server" estiver ativado, você poderá usá-lo.

Ao clicar em ">" à direita de "unofficial-kintone-mcp-server", as ferramentas disponíveis serão exibidas. Se houver alguma ferramenta que você não deseja usar, desative-a.

Procedimento de instalação local sem usar o arquivo mcpb

1. Requisitos

Node.js 20 ou superior
pnpm ou npm

2. Baixar o código-fonte

O local de download pode ser qualquer um, mas é recomendável colocá-lo em um caminho composto apenas por caracteres alfanuméricos, sem espaços.

3. Instalar as dependências

pnpm install

npm install

4. Editar o arquivo de configuração do aplicativo Claude Desktop

Localize o arquivo de configuração chamado claude_desktop_config.json e adicione as configurações na seção "mcpServers" deste arquivo, conforme o exemplo abaixo.

{
  "mcpServers": {
    "kintone": {
      "command": "node",
      "env": {
        "KINTONE_DOMAIN": "[あなたが使用するサブドメイン].cybozu.com",
        "KINTONE_USERNAME": "MCP接続で使用するkintoneユーザー名",
        "KINTONE_PASSWORD": "kintoneユーザーのパスワード（平文）"
      },
      "args": [
        "[kintone-mcp-serverを配置したパス]/server.js"
      ]
    }
  }
}

5. Reiniciar o aplicativo Claude Desktop

Após salvar as alterações no claude_desktop_config.json, feche e reinicie o aplicativo Claude Desktop. Como o aplicativo pode permanecer em execução em segundo plano mesmo parecendo ter sido fechado, clique com o botão direito no ícone da bandeja e selecione "Sair".

Como usar

1. Verificação de funcionamento

Primeiro, pergunte ao Claude: "Descubra o ID do aplicativo do aplicativo kintone 'exemplo de nome de aplicativo acessível com o usuário kintone configurado'". O nome do aplicativo kintone inserido aqui deve ser especificado exatamente, palavra por palavra.

2. Lista de funcionalidades fornecidas por este servidor MCP

Consulte docs/tool-annotations.md para obter os atributos de anotação de cada ferramenta.

Operações de registro

get_record: Obtém um registro de um aplicativo kintone
search_records: Pesquisa registros em um aplicativo kintone
create_record: Cria um novo registro em um aplicativo kintone
update_record: Atualiza um registro existente em um aplicativo kintone
upsert_record: Cria ou atualiza um registro especificando um campo de prevenção de duplicidade em um aplicativo kintone (operação Upsert)
add_record_comment: Adiciona um comentário a um registro kintone
update_record_status: Atualiza o status de um registro kintone (gerenciamento de processos)
update_record_assignees: Atualiza os responsáveis de um registro kintone (gerenciamento de processos)
get_record_comments: Obtém os comentários de um registro kintone

Operações de arquivo

upload_file: Envia um arquivo para o kintone
download_file: Baixa um arquivo do kintone (atenção: na implementação atual, arquivos com mais de 1 MB podem não ser baixados corretamente)

Informações do aplicativo

get_apps_info: Obtém informações do aplicativo kintone combinando nome do aplicativo (pesquisa de string), ID do aplicativo (número natural), código do aplicativo e ID do espaço (app_name ou app_id é obrigatório)
get_form_layout: Obtém o layout do formulário de um aplicativo kintone
get_form_fields: Obtém as informações dos campos do formulário de um aplicativo kintone (somente ambiente de produção; para ambiente de pré-visualização, use get_preview_form_fields)
get_app_actions: Obtém as configurações de ações do aplicativo kintone
get_app_plugins: Obtém a lista de plugins adicionados a um aplicativo kintone
get_process_management: Obtém as configurações de gerenciamento de processos de um aplicativo kintone
get_app_acl: Obtém as permissões de acesso de um aplicativo kintone
get_field_acl: Obtém as permissões de acesso dos campos de um aplicativo kintone
get_record_acl: Obtém as permissões de acesso de um registro especificado
evaluate_records_acl: Avalia as permissões de acesso de registros sob condições especificadas
get_views: Obtém as configurações das listas (visões) de um aplicativo kintone
get_reports: Obtém as configurações de gráficos de um aplicativo kintone
get_notifications: Obtém as configurações de condições de notificação de um aplicativo kintone
get_per_record_notifications: Obtém as configurações de notificação por registro de um aplicativo kintone
get_reminder_notifications: Obtém as configurações de notificação de lembrete de um aplicativo kintone

Operações de aplicativo

create_app: Cria um novo aplicativo kintone
add_fields: Adiciona campos a um aplicativo kintone
update_field: Atualiza as configurações de um campo kintone existente
update_form_layout: Altera o layout do formulário de um aplicativo kintone
update_app_settings: Altera as configurações gerais do aplicativo
deploy_app: Inicia a operação de produção de um aplicativo kintone (refletir no ambiente de produção)
get_deploy_status: Verifica o status de reflexão das configurações do aplicativo no ambiente de produção
move_app_to_space: Move um aplicativo kintone para um espaço especificado
move_app_from_space: Remove um aplicativo kintone de um espaço
update_app_acl: Atualiza as permissões de acesso de um aplicativo kintone
update_field_acl: Atualiza as permissões de acesso dos campos de um aplicativo kintone
update_views: Atualiza as configurações das listas (visões) de um aplicativo kintone
update_reports: Atualiza as configurações de gráficos de um aplicativo kintone
update_notifications: Atualiza as configurações de condições de notificação de um aplicativo kintone
update_per_record_notifications: Atualiza as configurações de notificação por registro de um aplicativo kintone
update_reminder_notifications: Atualiza as configurações de notificação de lembrete de um aplicativo kintone
update_process_management: Atualiza as configurações de gerenciamento de processos de um aplicativo kintone
update_app_actions: Atualiza as configurações de ações de um aplicativo kintone

Operações de espaço

get_space: Obtém informações gerais de um espaço
update_space: Atualiza as configurações de um espaço
update_space_body: Atualiza o texto principal de um espaço
get_space_members: Obtém a lista de membros de um espaço
update_space_members: Atualiza os membros de um espaço
add_thread: Adiciona um tópico a um espaço
update_thread: Atualiza um tópico
add_thread_comment: Adiciona um comentário a um tópico
add_guests: Adiciona um usuário convidado
update_space_guests: Atualiza os membros convidados de um espaço

Informações de usuários e grupos

get_users: Obtém informações de usuários do kintone
get_groups: Obtém informações de grupos do kintone
get_group_users: Obtém a lista de usuários pertencentes a um grupo especificado

Informações de conexão kintone

get_kintone_domain: Obtém o domínio de conexão do kintone
get_kintone_username: Obtém o nome de usuário usado para conexão com o kintone

Outros

Escrevi um blog sobre o que você pode fazer com este servidor MCP. Leia se tiver interesse.

Além disso, publicamos separadamente aqui um código de exemplo de um servidor MCP remoto com suporte a OAuth que pode ser usado com o Claude ou ChatGPT na versão para navegador web.

"kintone" é uma marca registrada da Cybozu, Inc.

O conteúdo aqui descrito tem caráter meramente informativo e não oferecemos suporte individual. Agradecemos a compreensão de que não podemos responder a perguntas sobre as configurações ou a relatos de que não funciona no seu ambiente.