Integração · Documentos

Conecte Claude e ChatGPT ao ClickHelp

Pergunte à sua IA onde algo é explicado na documentação do ClickHelp, ou peça-lhe que redija um novo tópico no local adequado. Ela pode pesquisar tópicos em vários projetos, ler e atualizar o conteúdo e status dos tópicos, criar pastas e mover entradas na tabela de conteúdos. Quando a documentação estiver pronta, ela pode publicar um projeto e acompanhar a tarefa de publicação.

Ligar ClickHelp gratuitamente

Plano gratuito, sem cartão de crédito. Demora cerca de um minuto.

Experimente pedir

“Onde explicamos como redefinir uma senha?”
A IA executa uma busca completa em todos os seus tópicos e exibe os tópicos correspondentes com seus projetos.
“Escreva um tópico chamado 'Exportando relatórios' sob a pasta Relatórios no projeto Guia do Usuário.”
Ela localiza a pasta na tabela de conteúdos e cria o tópico com título e corpo HTML ali.
“Atualize o tópico Instalação com os novos requisitos do sistema e defina-o como Pronto para revisão.”
Ela lê o tópico, atualiza o corpo e define o status de fluxo de trabalho que você nomeou.

O que a sua IA pode fazer

Tópicos

Pesquise, leia, crie e atualize tópicos com conteúdo HTML, status de fluxo de trabalho e responsável.

Tabela de conteúdos

Leia a tabela de conteúdos, crie pastas e renomeie ou mova entradas.

Projetos e publicação

Liste e crie projetos, publique um projeto, altere a visibilidade da publicação e acompanhe tarefas de publicação.

“Mova a pasta FAQ para o final da tabela de conteúdos.”
Ela lê a tabela de conteúdos e move a pasta para a nova posição.
“Publique o projeto Guia do Usuário como uma atualização à publicação existente.”
Ela inicia a publicação e acompanha a tarefa até que seja concluída. O resultado é visível aos seus leitores.
“Pergunte ao AnswerGenius o que nossa documentação diz sobre autenticação única.”
Ela envia a pergunta ao AnswerGenius, o assistente de IA do ClickHelp, opcionalmente dentro de um único projeto e retorna a resposta.

55 ferramentas para ClickHelp

Estas ferramentas são ativadas quando estabelece a ligação. Pode desativar qualquer uma delas ou exigir a sua aprovação antes de ser executada.

ask_answergeniusAltera dadosFaça uma pergunta à assistente de IA AnswerGenius sobre sua documentação (`query`), opcionalmente dentro de um `project_id`.
create_projectAltera dadosCrie um novo projeto de documentação com `project_name`; opcionalmente copie de `source_project_id`.
create_statusAltera dadosCrie um novo status. Obrigatório: nome ou tipo. Resumo da API: Criar status de fluxo de trabalho.
create_toc_folderAltera dadosCrie uma pasta no índice de conteúdo de um projeto: `project_id` e `caption`, opcionalmente sob `parent_id`.
create_topicAltera dadosCrie um tópico em um projeto: `project_id`, tópico `id`, `title` e HTML `body`; opcionalmente uma `parent_toc_node_id`, status e responsável.
create_transitionAltera dadosCrie uma nova transição. Obrigatório: nome do status origem ou nome do destino. Resumo da API: Criar transição de fluxo de trabalho.
create_userAltera dadosCrie um novo usuário. Obrigatório: nome do usuário ou informações do usuário. Resumo da API: Criar usuário.
delete_nodeElimina dadosExclua permanentemente um nó pelo seu ID de nó. Ação destrutiva; pode exigir aprovação. Resumo da API: Excluir Nó TOC.
delete_nodesMovimenta dinheiroExclua permanentemente um nó pelo ID do projeto. Ação financeira ou irreversível; pode exigir aprovação. Resumo da API: Excluir vários Nós TOC.
delete_projectElimina dadosExclua permanentemente um projeto pelo seu ID de projeto. Ação destrutiva; pode exigir aprovação. Resumo da API: Excluir projeto/publicação.
delete_project_productsMovimenta dinheiroExclua permanentemente um produto pelo ID do projeto. Ação financeira ou irreversível; pode exigir aprovação. Resumo da API: Excluir vários tópicos.
delete_statusElimina dadosExcluir permanentemente um status pelo seu nome. Ação destrutiva; pode exigir aprovação. Resumo da API: Excluir status de fluxo.
delete_storageElimina dadosExcluir permanentemente um armazenamento pelo caminho do arquivo. Ação destrutiva; pode exigir aprovação. Resumo da API: Excluir arquivo.
delete_storagesMovimenta dinheiroExcluir permanentemente um armazenamento. Ação financeira ou irreversível; pode exigir aprovação. Resumo da API: Excluir múltiplos arquivos.
delete_topicElimina dadosExclua permanentemente um tópico por `project_id` e `topic_id`. Não pode ser desfeito.
delete_transitionElimina dadosExcluir permanentemente uma transição pelo seu ID de transição. Ação destrutiva; pode exigir aprovação. Resumo da API: Excluir transição de fluxo.
download_projectAltera dadosBaixar o documento para um projeto. Resumo da API: Backup do projeto.
export_projectsAltera dadosExportar projetos. Resumo da API: Exportar publicação.
get_home_page_contentListar páginas. Filtros opcionais: site. Resumo da API: Obter conteúdo da página inicial.
get_home_page_settingsListar páginas. Filtros opcionais: publicadas ou site. Resumo da API: Obter configurações da página inicial.
get_nodeObter um nó pelo seu ID de nó. Resumo da API: Obter Nó da TOC.
get_projectObter um projeto ou publicação pelo `project_id`.
get_statusObter um status pelo seu nome de status. Resumo da API: Obter status do fluxo.
get_storageObter um armazenamento pelo caminho do arquivo. Resumo da API: Obter informações de arquivo(s) ou pasta.
get_task_statusVerificar o status de uma tarefa de longa duração (como publicação) pelo `task_key`.
get_topicObter um tópico pelo `project_id` e `topic_id`, incluindo seu corpo HTML.
get_userObter um perfil de usuário pelo `user_login`.
get_user_event_queriesObter um evento de usuário por login do usuário. Resumo da API: Obter Consultas de Pesquisa.
import_to_existing_projectAltera dadosImportar um projeto (ID do projeto). Resumo da API: Importar para projeto existente.
list_pagesListar páginas. Filtros opcionais: site. Resumo da API: Obter configurações do portal.
list_project_publicationsListar as publicações feitas a partir de um projeto pelo `project_id`.
list_project_usersListar usuários para um projeto. Filtros opcionais: tipos. Resumo da API: Obter usuários com acesso ao projeto/publicação.
list_projectsListar projetos de documentação e publicações, opcionalmente filtrados por `types` ou `parent_id`.
list_toc_node_childrenListar as entradas filhas de um nó da tabela de conteúdos pelo `project_id` e `toc_node_id`.
list_toc_nodesListar as entradas da tabela de conteúdos de um projeto pelo `project_id`.
list_topicsListar ou pesquisar tópicos em um projeto pelo `project_id`, opcionalmente correspondendo a `q`.
list_transitionsListar transições. Resumo da API: Obter todas as transições de fluxo.
list_user_event_productsListar produtos para um evento de usuário. Filtros opcionais: data inicial ou final. Resumo da API: Obter Visualizações de Tópico.
list_user_projectsListar projetos para um usuário. Resumo da API: Obter projetos/publicações disponíveis para o usuário.
list_user_tokensListar tokens para um usuário. Filtros opcionais: exp ou muse. Resumo da API: Obter token de login.
list_usersListar todos os usuários no portal do ClickHelp.
list_workflow_statusesListar os status de fluxo que os tópicos podem ter.
publish_projectVisível para outras pessoasPublicar um projeto como publicação online via `project_id`, atualizando opcionalmente uma publicação existente (`updated_pub_id`). O resultado é visível para os leitores.
search_documentationPesquisa de texto completo entre tópicos para `q`, opcionalmente limitado a `project_ids`.
submit_homeVisível para outras pessoasPublicar uma página inicial. Tem efeitos visíveis fora deste sistema. Resumo da API: Publicar página inicial.
update_home_page_draftVisível para outras pessoasAtualizar uma página existente. Apenas os campos passados são alterados. Os efeitos são visíveis fora deste sistema. Resumo da API: Atualizar rascunho da página inicial.
update_pagesVisível para outras pessoasAtualizar uma página existente. Apenas os campos passados são alterados. Os efeitos são visíveis fora deste sistema. Resumo da API: Atualizar configurações do portal.
update_publication_visibilityAltera dadosAlterar a `visibility` de uma publicação via `project_id`; listar os campos alterados em `updated_fields` (ex: visibilidade).
update_statusAltera dadosAtualizar um status existente identificado pelo nome do status. Apenas os campos passados são alterados. Resumo da API: Atualizar status de fluxo de trabalho.
update_storageAltera dadosAtualizar um armazenamento existente identificado pelo caminho do arquivo. Apenas os campos passados são alterados. Resumo da API: Atualizar conteúdo do arquivo.
update_toc_nodeAltera dadosRenomear ou mover um nó da tabela de conteúdos via `project_id` e `node_id`; listar os campos alterados em `updated_fields`.
update_topicAltera dadosAtualizar um tópico via `project_id` e `topic_id` (título, corpo, status, responsável); listar os campos alterados em `updated_fields`, ex: "título,corpo".
update_userAltera dadosAtualizar um usuário existente identificado pelo login do usuário. Apenas os campos passados são alterados. Resumo da API: Alterar perfil do usuário.
upload_projectAltera dadosImportar um projeto. Resumo da API: Importar novo projeto.
upload_storageAltera dadosEnviar um armazenamento (caminho de arquivo). Resumo da API: Criar Arquivo ou Pasta / Iniciar Upload Resumível.

Configure em três passos

1
Escolha a aplicação
Crie uma conta gratuita no PipMCP e escolha ClickHelp na lista de aplicações.
2
Cole a sua chave
Cole o endereço do portal ClickHelp (sem https://), seu login no ClickHelp e uma chave API. O portal precisa do complemento REST API & MCP, e apenas contas Contributor podem obter chaves API. Clique na imagem do perfil, escolha Meu Perfil, encontre seu login acima do título, clique em Reset Chave API e use a chave que você recebe no email.
3
Adicione a ligação à sua IA
Receberá uma ligação MCP pessoal. Adicione-a ao Claude, ao ChatGPT ou ao Cursor:
1. Clique no seu nome e depois em Definições › Conectores › Adicionar conector personalizado.
2. Cole a sua ligação no campo URL do servidor MCP remoto.
3. Ative-o no menu + de uma conversa.

Perguntas

O que a IA pode fazer no ClickHelp?

Ela pode listar e ler projetos, publicações, tópicos, entradas da tabela de conteúdos, status de fluxo de trabalho e usuários, pesquisar sua documentação e perguntar ao AnswerGenius. Ela pode criar projetos, tópicos e pastas, atualizar tópicos e entradas da tabela de conteúdos, publicar projetos, alterar a visibilidade da publicação e excluir tópicos se você ativar essa ferramenta.

A IA vê minha chave de API do ClickHelp?

Não. Suas credenciais do ClickHelp estão criptografadas em repouso e nunca são mostradas à IA. Após salvar, elas não aparecem novamente, nem mesmo para você. A IA só vê os resultados das ferramentas que chama.

Posso controlar o que a IA é autorizada a fazer?

Sim. Você escolhe quais ferramentas estão ativadas, então pode começar com apenas pesquisa e leitura. Publicar torna o conteúdo visível aos leitores e excluir um tópico não pode ser desfeito. Ambos podem exigir sua aprovação antes de rodarem. Cada chamada de ferramenta é registrada.

Funciona com o ChatGPT?

Sim. No ChatGPT, vá em Configurações › Aplicações e Conectores › Avançado, ative o Modo Desenvolvedor e adicione seu link do PipMCP. O Modo Desenvolvedor requer um plano pago do ChatGPT: Plus, Pro, Business ou Enterprise. O mesmo link funciona no Claude (Configurações › Conectores › Adicionar conector personalizado), Cursor e outros clientes MCP.

Qual é o custo?

O PipMCP tem um plano gratuito, e você não precisa de cartão de crédito para começar. Planos pagos são cobrados por tarefa concluída. Você também precisa de sua própria conta do ClickHelp.

O que preciso no ClickHelp para conectar?

Seu portal precisa do ad-on REST API & MCP, e você precisa de uma conta Contributor, porque apenas esses podem obter chaves de API. Você obtém a chave clicando em Reset API key na página do perfil; o ClickHelp então envia por e-mail. Use essa chave, não sua senha.