Docsbook
Visão geral

Servidor MCP

O servidor MCP do Docsbook é um servidor remoto do Protocolo de Contexto de Modelo que expõe sua documentação e toda a sua superfície administrativa a um agente de IA. Conecte o Claude Code ou qualquer cliente compatível com MCP a um endpoint e leia suas páginas, faça alterações, leia análises e mude configurações sem sair do editor.

Esta página é a referência para o que o servidor oferece e o que uma chamada utiliza. Cada ferramenta listada aqui pode ser chamada por qualquer cliente conectado; o custo de uma chamada medida está na página de preços do Docsbook e na própria linha de cada ferramenta em seu painel administrativo.

O que é o servidor MCP do Docsbook?#

O servidor MCP do Docsbook expõe 310 ferramentas por meio do Model Context Protocol, um padrão aberto para fornecer ferramentas, recursos e prompts a agentes de IA por meio de uma interface RPC tipada. Dessas ferramentas, 18 são registros, um para cada evento de webhook; 136 são ferramentas de ação, cada uma executando uma etapa do trabalho de documentação sobre um assunto e respondendo com um payload JSON validado; 41 são agentes, um por objetivo, cuja implementação consiste em uma sequência dessas ações na ordem; 12 são apoiadas por um fornecedor externo de scraping para os itens que o próprio crawler do Docsbook não consegue alcançar; cinco são coletores que devolvem as evidências nas quais as ações se baseiam, sem qualquer julgamento; e quatro iniciam e leem execuções em segundo plano. As 94 restantes são as ferramentas nomeadas individualmente que abrangem operações de workspace, conteúdo, chat, análises e webhooks — entre elas estão as duas que conectam e configuram um repositório ou site como fonte de verdade, e as duas que encontram e ativam um agente permanente com base em uma programação, um evento ou nos commits de um repositório conectado.

Endpoint#

O servidor MCP do Docsbook é disponibilizado em uma única URL para cada espaço de trabalho e cada cliente:

https://docsbook.io/api/mcp/server

A autenticação é um fluxo de código de autorização OAuth com PKCE. O cliente recebe um único token Bearer opaco, que apresenta em cada chamada; nenhum token de atualização é emitido e o token não expira por conta própria, portanto, a rotação significa revogá-lo no painel e autorizar novamente. Não há uma URL MCP por projeto para consultar: o fluxo OAuth é associado à conta conectada, e o cliente escolhe o espaço de trabalho posteriormente. Consulte segurança do servidor MCP para conhecer o fluxo, os escopos e as lacunas.

Como conecto meu cliente de IA ao Docsbook?#

Aponte o seu cliente para https://docsbook.io/api/mcp/server e conclua a solicitação OAuth no navegador. O servidor MCP do Docsbook é um servidor HTTP remoto com OAuth, portanto todos os clientes MCP modernos se conectam a ele usando o mesmo endpoint e sem a necessidade de executar um processo local. As subseções abaixo fornecem o comando exato ou o arquivo de configuração para cada cliente.

Você também pode navegar pelo catálogo dentro do seu próprio projeto: abra o painel de administração e selecione MCP na barra lateral. Na primeira vez que o abrir, a seção exibirá um painel Ativar com o comando de instalação do seu cliente, para que você possa se conectar antes de ler o catálogo; ao pressioná-lo, será iniciado um guia curto sobre a própria tabela. Por trás dele há uma tabela com todas as ferramentas que o servidor oferece no momento, lida diretamente do servidor, e não de uma cópia previamente registrada, com a categoria de cobrança de cada ferramenta, o preço por chamada, por quanto tempo uma chamada normalmente permanece aberta e se os leitores podem chamá-la sem um token. Pesquise nela, restrinja os resultados com Filtros — as categorias de cobrança, cada uma exibida com seu próprio preço — ou ordene por qualquer coluna. Passar o cursor sobre uma linha abre um cartão com o restante das informações sobre essa ferramenta: o que ela faz, quanto custa uma chamada e por quanto tempo normalmente permanece aberta, quantos argumentos recebe e quantos deles são obrigatórios, quantos exemplos funcionais a utilizam e — no seu próprio projeto — quanto ela já custou até agora e quando você a chamou pela última vez, com o ID chamável pronto para copiar. Clicar em uma linha abre a página própria dessa ferramenta, e a página tem um endereço: a URL contém a ferramenta, para que você possa atualizá-la, adicioná-la aos favoritos ou enviá-la a um colega, fazendo com que ele chegue à mesma ferramenta em vez de voltar para uma tabela com trezentas linhas. Tudo nela diz respeito a essa única ferramenta. Seus argumentos aparecem em um formulário com um botão Executar que faz uma chamada real contra este projeto, e o botão exibe o preço antes que o valor seja debitado. Abaixo fica o seu histórico de chamadas, obtido pela mesma tabela de Feeds que você lê em qualquer outro lugar, restringido a essa única ferramenta: uma linha por chamada; ao expandir uma linha, a chamada é exibida por completo — o que foi enviado, o que voltou, quem a solicitou (a sua execução, um agente externo, uma programação ou um evento), quanto tempo levou, qual foi o preço e o que de fato foi debitado do seu saldo. Abaixo disso está o que a executa sem supervisão: uma programação, um evento ou um dos seus Feeds salvos, para que uma chamada possa acompanhar um feed inteiro em vez de um único nome de evento; cada linha ativada mostra aquilo em que já é executada, para que você nunca substitua uma execução configurada anteriormente sem perceber. Por último, a página exibe os agentes que usam esta ferramenta — os cartões da seção Agents cuja rota realmente a chama, com os ativados primeiro e cada um com seu próprio interruptor, para que você possa colocar a ferramenta em uma programação a partir da página onde acabou de ler quanto custa uma chamada. Abaixo deles há um exemplo funcional para copiar para o seu próprio cliente; o que é executado dentro do Docsbook é a chamada.

Claude Code#

claude mcp add --transport http docsbook https://docsbook.io/api/mcp/server

A primeira chamada abre uma aba do navegador para OAuth. Após o consentimento, as ferramentas ficam disponíveis dentro do Claude Code.

Cursor#

Cursor não tem o comando mcp add, mas aceita um link de instalação com um clique:

cursor://anysphere.cursor-deeplink/mcp/install?name=docsbook&config=eyJ1cmwiOiJodHRwczovL2RvY3Nib29rLmlvL2FwaS9tY3Avc2VydmVyIiwidHlwZSI6Imh0dHAifQ==

Ou adicione o servidor a ~/.cursor/mcp.json (ou use Configurações → MCP & Integrações → Novo servidor MCP):

{
  "mcpServers": {
    "docsbook": {
      "url": "https://docsbook.io/api/mcp/server"
    }
  }
}

Recarregar Cursor — OAuth abre no navegador na primeira utilização.

Codex CLI#

codex mcp add docsbook --url https://docsbook.io/api/mcp/server

Ou edite a configuração diretamente — Codex armazena servidores MCP em ~/.codex/config.toml:

[mcp_servers.docsbook]
url = "https://docsbook.io/api/mcp/server"

WindSurf#

Edite ~/.codeium/windsurf/mcp_config.json e atualize o painel Cascade:

{
  "mcpServers": {
    "docsbook": {
      "serverUrl": "https://docsbook.io/api/mcp/server"
    }
  }
}

Cline#

Abra Cline → Servidores MCP → Configurar Servidores MCP e cole:

{
  "mcpServers": {
    "docsbook": {
      "url": "https://docsbook.io/api/mcp/server",
      "transportType": "http"
    }
  }
}

Gemini CLI#

gemini mcp add --transport http docsbook https://docsbook.io/api/mcp/server

O escopo padrão é o projeto atual — adicione --scope user para instalá-lo globalmente. Ou adicione manualmente a ~/.gemini/settings.json (note que a chave é httpUrl; url lá significa SSE):

{
  "mcpServers": {
    "docsbook": {
      "httpUrl": "https://docsbook.io/api/mcp/server"
    }
  }
}

GitHub Copilot (VS Code)#

code --add-mcp '{"name":"docsbook","type":"http","url":"https://docsbook.io/api/mcp/server"}'

Ou crie .vscode/mcp.json dentro do seu espaço de trabalho, então ative o servidor a partir do seletor MCP do Copilot Chat (note que a chave é servers, não mcpServers):

{
  "servers": {
    "docsbook": {
      "type": "http",
      "url": "https://docsbook.io/api/mcp/server"
    }
  }
}

ChatGPT#

ChatGPT suporta MCP remoto através de Conectores, nos próprios planos pagos do ChatGPT. Essa exigência é da OpenAI, não da Docsbook.

  1. Abra ChatGPT → Configurações → Conectores → Avançado → Modo desenvolvedor.
  2. Clique em Criar e cole a URL: https://docsbook.io/api/mcp/server.
  3. Autorize no navegador quando solicitado.

Para que servem as ferramentas Docsbook MCP?#

As ferramentas Docsbook MCP existem para fazer uma das quatro coisas acontecerem: mais leitores qualificados chegam, mais deles saem com o que vieram buscar, mais leitores com intenção de compra são levados adiante pelo assistente, e menos perguntas chegam a uma pessoa. Tudo abaixo está agrupado por qual dessas quatro atende.

Sua documentação não é um centro de custo. É um canal com três funções: ser encontrado (pelo Google e pelos assistentes de IA que seus compradores agora perguntam em vez do Google), converter o leitor (uma visita que termina sem nada é um cliente perdido que nunca reclamou), e provar o que funcionou (para que a próxima edição seja uma decisão, não um palpite).

Existem apenas quatro maneiras de uma ferramenta de documentação gerar receita, e cada ferramenta abaixo atende a uma delas:

Alavanca Mecanismo Ferramentas principais
Aquisição Mais leitores qualificados chegam, da busca e das respostas de IA update_seo, update_geo, update_aeo, get_search_rankings
Conversão Mais leitores que chegam saem com o que vieram buscar get_visit_outcomes, get_dead_end_pages, get_content_health, get_route_patterns
Vendas O assistente leva leitores com intenção de compra adiante em vez de apenas responder get_chat_intent, get_chat_conversations, set_chat_system_prompt, set_chat_hooks
Custo evitado Perguntas respondidas pela documentação são perguntas não respondidas por uma pessoa get_ai_unanswered, get_failed_searches, get_search_zero_click, get_insights

Uma ferramenta que não atende a nenhuma dessas retorna contexto, não uma decisão. Pageviews: 12,340 é contexto. 31% of your readers left with nothing é uma decisão.

Sendo encontrado#

Ferramenta O que vale
update_seo Meta tags, sitemap, OpenGraph. Requisitos básicos: sem isso, páginas que merecem ranquear não conseguem.
update_geo Otimização de Motor Generativo — estrutura a página para que um LLM possa citá-la e atribuí-la a você. A diferença entre ser a fonte de uma resposta de IA e ser invisível dentro de uma.
update_aeo Otimização de Motor de Respostas — molda o conteúdo na forma de resposta direta que assistentes de IA levantam verbatim.
get_search_rankings Posições reais do Google Search Console, além do "conjunto que vale a pena melhorar" na posição 5–20 — páginas que o Google já mostra que ainda não estão ganhando cliques. Transforma "devemos fazer SEO" em uma página nomeada e uma consulta nomeada. Atrasa o Google em ~2 dias.
get_analytics (análise de AI-bot) Se os crawlers do ChatGPT, Perplexity e Claude leem você. Um zero aqui significa que o trabalho de GEO não está funcionando — sem rastreamento, sem citação, sem referência.

Os compradores cada vez mais perguntam a um assistente antes de perguntar a um vendedor. Se o assistente responde com a documentação de um concorrente, você nunca entra na lista curta e a perda não aparece em nenhum painel.

Não perder o leitor#

get_visit_outcomes é o número do título de todo o produto: classifica cada visita como sucesso / beco sem saída / rejeição / parcial e relata a taxa de beco sem saída e a taxa de resolução autônoma. Um beco sem saída é um leitor que pesquisou, perguntou à IA ou abriu várias páginas — e ainda saiu sem nada. Tudo abaixo responde "…e onde exatamente?"

Ferramenta O que vale
get_dead_end_pages A fila de reescrita, classificada. Linhas marcadas terminal_success são páginas das quais as pessoas saem porque conseguiram o que precisavam — a ferramenta protege suas melhores páginas de serem "corrigidas".
get_content_health Uma pontuação de 0–100 por página, combinando saídas de beco sem saída com feedback negativo. Substitui a referência cruzada de quatro relatórios manualmente em um grande conjunto de documentos.
get_rage_signals Páginas reentradas 3+ vezes em uma visita, A→B→A retornos, pesquisas repetidas. A taxa de beco sem saída diz que uma visita falhou; isso diz onde. A reentrada significa que a resposta deveria estar naquela página e não está — a solução é reestruturar, não novo conteúdo.
get_route_patterns As sequências de 2–4 páginas que os leitores realmente percorrem, e com que frequência cada uma termina bem. Uma rota frequente que termina mal é um defeito de navegação, não um problema de qualidade da página — reescrever essas páginas não resolverá.
get_reverse_funnel Trabalha de trás para frente a partir de visitas bem-sucedidas: quais páginas de entrada levam a um bom final. Não precisa de hipótese, então revela o caminho que os leitores encontraram que você nunca projetou.
get_forward_funnel Conclusão da rota que você declarou, e quais transições vazam. Sua taxa de conclusão de integração.
get_metric_timeseries Qualquer métrica de título por dia — a única ferramenta que responde "isso está piorando" e alinha uma mudança contra uma data de lançamento.
get_visits A evidência por trás das taxas: uma visita reconstruída de cada vez. Use quando um número for contestado, ou para vincular um leitor real a uma reclamação.
get_retention Taxa de retorno W1/W4 por coorte. A direção depende da seção: alto retorno é saudável para documentos de referência e um fracasso para integração.

Demanda que você não está atendendo#

Cada linha aqui é um ticket de suporte que você pode antecipar escrevendo uma página.

Ferramenta Quanto vale
get_ai_unanswered Perguntas que o assistente não conseguiu responder, nas próprias palavras do leitor. O plano de conteúdo mais barato que existe.
get_failed_searches Pesquisas que retornam zero resultados — a mesma lacuna por uma porta diferente.
get_search_zero_click Pesquisas que retornaram resultados e não tiveram clique. A lacuna que os relatórios de zero resultados perdem: a pesquisa funcionou e o leitor rejeitou todos os resultados, o que aponta para títulos e resumos — uma ordem de magnitude mais barata para corrigir do que os corpos das páginas.
get_popular_searches O que as pessoas mais procuram. Leia em relação a get_content_health na mesma página: alta demanda + baixa saúde = sua página quebrada mais cara.
get_negative_feedback Páginas com avaliação negativa, classificadas. O voto explícito do leitor, sem necessidade de inferência.
get_insights O resumo pré-combinado — lacunas de documentos, pesquisas sem resultados e páginas desaprovadas com estimativas de impacto, em uma única chamada. Comece aqui para "o que devo corrigir esta semana".

Vendas através do assistente#

O chat não é um widget de suporte. É o único lugar onde um prospecto expressa sua objeção em linguagem simples.

Ferramenta O que vale
get_chat_intent Conversas divididas por fase de compra — avaliação, precificação, integração, suporte, bug. Responde quem está decidindo se vai comprar e o que bloqueia a compra. Nomeia o concorrente quando os leitores mencionam um: inteligência competitiva que nenhum relatório de nível de página pode produzir.
get_chat_conversations Perguntas agrupadas por tópico, com click_through — a parte das conversas onde o leitor abriu uma página citada. Um tópico com intenção de compra e sem cliques é um vazamento de vendas: a resposta estava correta e não levou ninguém adiante. A unidade é uma conversa, não uma pergunta, porque quatro perguntas de um leitor preso e uma de cada um dos quatro leitores dão contagens idênticas e conclusões opostas.
set_chat_system_prompt Onde a solução se aplica — transforma o assistente de bibliotecário em vendedor: qualificar, lidar com a objeção, direcionar para uma demonstração.
set_chat_hooks / test_chat_hook Ganchos pré/pós-LLM: injetar contexto ao vivo (preço, disponibilidade, plano do leitor) ou capturar um lead no momento em que a intenção aparece.
get_ai_questions Registro de perguntas verbatim — matéria-prima para FAQ, e-mail de integração, manejo de objeções.

Uma objeção de preço expressa no chat de seus documentos vale mais do que uma visualização de página: o leitor se qualificou e disse exatamente o que o impede de comprar.

Agir sobre a descoberta#

Um diagnóstico sem correção é apenas um relatório. Estas ferramentas fecham o ciclo dentro de uma única ligação.

Ferramenta Para que serve
search_docs Secções literais e citáveis — modos de texto, regex, título ou caminho. É o que um agente lê antes de editar, para alterar as linhas certas.
search Pesquisa semântica (baseada em embeddings) — encontra uma página pelo que ela significa, não pelo que diz literalmente, usando um índice vetorial pré-construído. Capta a pergunta em linguagem natural que usa frases completamente diferentes do título da página. Disponível em todos os planos, e responde sempre: um projeto que ainda não tem índice recebe a mesma resposta através de texto completo, e a resposta indica qual motor foi executado (mode: semantic ou lexical). Disponibilizada sem token no endpoint público do seu projeto, para que o agente de um leitor também possa pesquisar a sua documentação.
get_doc_outline Todas as páginas com título, número de títulos e tamanho. Uma orientação económica antes de uma pesquisa ou escrita.
write_docs Faz commit de um ou vários ficheiros Markdown num único commit atómico do git. Transforma a análise numa alteração publicada.
fetch_url Lê uma página web pública como Markdown limpo. A ferramenta que permite a um agente verificar uma página em relação ao mundo fora do seu espaço de trabalho — os preços de um concorrente, o seu próprio site de marketing ou se uma ligação de que um documento depende continua ativa.
get_change_history Execute antes de editar. O que foi alterado anteriormente e como o tráfego das páginas afetadas evoluiu depois — com contagens brutas de visitas antes/depois, indicadores low_sample e pending, e sem uma conclusão deliberadamente (um commit e uma alteração no tráfego na mesma semana não são causa e efeito). Sem isto, a mesma recomendação continuará a ser feita para sempre com a mesma confiança.
get_page_diff_impact Execute depois de publicar. Essa edição ajudou realmente? Compara as páginas afetadas por um commit com as páginas que não foram afetadas, antes e depois — composição dos resultados, resolução autónoma e tempo até ao primeiro valor. As páginas não afetadas são o controlo, e esse é o ponto: o tráfego da documentação varia por razões não relacionadas com a sua edição, pelo que uma melhoria só conta se superar a tendência do site. Uma alteração que apenas a iguale é comunicada como sem efeito, não como uma vitória. Também divide as visitas por país, idioma do leitor e dispositivo, cada um junto da variação do mesmo segmento nas páginas não afetadas — é isso que transforma “o tráfego aumentou” numa decisão. Quando tiver definido um preço médio e um URL de call-to-action, também calcula o valor da edição — conversões e receita nas páginas afetadas, antes e depois.
update_navigation A correção de um defeito get_route_patterns ou get_reverse_funnel encontrado — muitas vezes mais barata e eficaz do que reescrever uma página.
find_skill / find_widget Descubra uma capacidade empacotada — uma competência de fluxo de trabalho, um widget interativo — em vez de criar uma.
list_issues / get_issue / create_issue O próprio rastreador de issues do GitHub do projeto. Nem toda descoberta é uma alteração que faz de imediato — create_issue é a forma de registar uma descoberta que não o seja, em vez de deixar a conversa terminar. Use list_issues primeiro, para que uma descoberta não duplique uma issue já aberta. Para criar uma issue é necessário um token de leitura e escrita; para ler, não.

Conhecendo sem olhar#

Um painel só funciona se alguém o abrir. Um webhook funciona sempre. Registrar um webhook custa uma chamada de gravação; cada entrega que ele faz depois é uma chamada de saída da rede Docsbook.

Ferramenta de evento O que vale
register_webhook_chat_no_answer O assistente acabou de falhar com um leitor — no Slack, em segundos, enquanto eles ainda podem estar na página.
register_webhook_search_no_results O mesmo, para busca.
register_webhook_traffic_spike / _drop Um pico é uma vitória de marketing que vale a pena perseguir ou um incidente que leva as pessoas a resolver problemas. Uma queda após um lançamento é uma regressão que você encontraria no próximo trimestre.
register_webhook_content_outdated Documentos se afastando do produto — a causa raiz da maioria das respostas ruins de IA.
register_webhook_chat_negative_feedback, _feedback_received A reclamação explícita do leitor, direcionada a quem possui essa seção.
register_webhook_usage_limit_approaching, _overage_limit_reached Controle de orçamento — sem faturas surpresa.
list_webhooks, unregister_webhook, list_webhook_deliveries, replay_webhook_delivery, test_webhook Operar o acima: auditar, tentar novamente, verificar.

Alcance e propriedade#

Ferramenta O que vale
update_languages Ative um idioma-alvo. Leia junto com a divisão por país/idioma em get_analytics: traduza onde os leitores já estão, não onde você espera que eles estejam.
set_translation_mode, upload_translation, approve_translation, list_pending_translations, get_translation, delete_translation O pipeline de tradução — automático ou fornecido externamente com aprovação humana.
update_access Espaço de trabalho privado, senha ou seu próprio SSO/OIDC. Desbloqueia a venda para empresas cuja aquisição exige isso.
update_domain Documentos em seu próprio domínio — a autoridade de SEO acumula-se para você, não para um subdomínio de fornecedor.
update_branding, update_ui_settings Seu produto, não o de uma plataforma.

As combinações que pagam#

Nenhuma ferramenta única acima é o produto. Esses loops são.

Loop 1 — "Qual página está me custando clientes?"#

get_visit_outcomes      → the rate: 31% of visits end with nothing
get_dead_end_pages      → which pages those visits died on
get_rage_signals        → what the reader was trying to do there
get_change_history      → has this page been "fixed" before, and did it work?
search_docs → write_docs → ship the fix
get_page_diff_impact    → did the edited pages beat the pages you did not touch?

A taxa sozinha é ineficaz, a lista de páginas sozinha carece de uma causa, e uma correção sem get_change_history repete uma edição falha com total confiança. O último passo é o que fecha o ciclo: uma linha de tendência em todo o site se move por uma dúzia de razões, então "a taxa melhorou após meu commit" é apenas evidência quando as páginas que você editou melhoraram mais do que as que você deixou de lado. Somente a sequência produz uma mudança que você pode defender.

Loop 2 — "Minha navegação está enganando os leitores?"#

get_route_patterns   → a frequent 3-page route that keeps ending badly
get_reverse_funnel   → the route successful readers actually take
update_navigation    → promote the working entry point
get_forward_funnel   → confirm completion on the declared route improved

Uma rota que falha enquanto suas páginas individuais têm um bom desempenho é um defeito de navegação — get_content_health continuaria apontando para páginas saudáveis para sempre.

Loop 3 — "Onde estão vazando os negócios?"#

get_chat_intent          → 40 pricing-stage conversations, a competitor named in 12
get_chat_conversations   → those topics have near-zero click_through
set_chat_system_prompt   → handle that objection, route to a demo
write_docs               → a comparison page that answers it once and for all
get_chat_intent (later)  → did the objection stop recurring?

O único loop em qualquer produto de documentação que começa com uma objeção declarada e termina com uma resposta enviada. click_through é o que separa "o assistente respondeu" de "o assistente vendeu".

Loop 4 — "Estou visível para a IA e isso trouxe alguém?"#

update_geo + update_aeo   → structure content for citation
get_analytics (ai_bots)   → confirm crawlers are actually reading it
get_search_rankings       → track classic-search position alongside
get_analytics (referrers) → referrals arriving from AI assistants
get_visit_outcomes        → and whether those arrivals end in success

A última etapa é a que todo mundo ignora. O tráfego de uma resposta de IA que não leva a lugar nenhum é pior do que nenhum tráfego — você conquistou a visibilidade e queimou a impressão.

O loop de autocura#

Execute o Loop 1 em um cronograma a partir do CI:

weekly:  get_content_health  → take the worst 3
         get_change_history  → skip anything already tried and failed
         search_docs → write_docs → open a PR
         get_page_diff_impact → report on the PR whether the edited pages
                                beat the untouched ones, or say they did not

Documentação que se repara e mostra seu trabalho — "vi o problema" e "corrigi o problema" sem deixar a conexão.

Entregando o trabalho completo#

Cada ferramenta acima responde dentro da chamada que a solicitou. Quatro não respondem, e esse é o ponto delas.

Auditar um site, construir um, reestruturá-lo ou configurar os monitores que o mantêm honesto é questão de minutos de trabalho — lendo páginas, raciocinando sobre números, comprometendo arquivos. find_skill lida com isso entregando o SKILL.md ao seu agente, que só funciona se seu agente também estiver conectado aqui, tiver escolhido um espaço de trabalho e gastar vinte chamadas de ferramenta nisso. Esses quatro executam a habilidade do nosso lado, em vez disso, contra seu espaço de trabalho, com o conjunto completo de ferramentas administrativas para as quais a habilidade foi escrita.

Ferramenta O que vale
run_docs_analyze A auditoria completa docs-analyze, executada para você: o que está errado, julgado a partir das posições de busca, comportamento do leitor e seus próprios objetivos — além da lacuna que nenhum número mostra, os públicos e casos de uso que os documentos nunca abordam. Está declarado em modo de auditoria, portanto não pode mudar nada e funciona com um token somente leitura.
run_docs_create O pipeline completo docs-create: audite o produto, decida a estrutura, escreva as páginas, publique. Do seu site, um repositório, outra plataforma que você está deixando, ou apenas um nome de produto.
run_docs_manage O livro de regras docs-manage aplicado em vez de citado: páginas reescritas, o site configurado, objetivos e funis declarados. Use-o quando o pedido for um julgamento ("faça isso bom") em vez de um valor ("defina o acento para #0f0").
run_docs_automate docs-automate, para que as verificações continuem acontecendo: guardas de desvio, webhooks, verificações de CI, alertas e monitores permanentes.

Iniciar um trabalho e ler seu resultado são duas chamadas separadas. Uma chamada run_docs_* retorna { run_id, state: "queued" } — nunca descobertas, nunca páginas. get_agent_run retorna o estado, progresso ao vivo enquanto está em execução, e uma vez que tenha sido bem-sucedido, o relatório, cada ação que a execução tomou e o que mudou. list_agent_runs encontra um id de execução que você perdeu; cancel_agent_run para uma que não terminou, sem desfazer o que já foi comprometido.

As três que escrevem requerem um token leitura-gravação. run_docs_analyze não requer, porque não pode escrever.

Comprando a evidência sem a opinião#

Uma auditoria faz sete coisas em uma chamada: coleta, normaliza, interpreta, julga, pontua, classifica, recomenda. Execute os dois primeiros duas vezes e você obterá a mesma resposta, e qualquer um pode refazê-los manualmente e verificar. A partir de judge em diante, a resposta é do modelo. Ambas as metades costumavam ser cobradas como uma execução de agente, o que significava que a metade que você pode verificar era vendida pelo preço da metade que você tem que confiar.

Cinco coletores são a primeira metade por conta própria, cobrados como um probe em vez de como uma execução de agente:

Ferramenta O que ela devolve
collect_page_text Suas páginas ao vivo como o fio realmente as serve — status, título, meta descrição, cabeçalhos, blocos de código e quantas palavras de prosa sobrevivem sem um motor JavaScript — ao lado do tamanho da fonte que armazenamos para o mesmo caminho. A diferença entre esses dois é a linha: 8 000 caracteres no repositório chegando como 40 palavras é uma página que é perfeita para cada verificação lendo a fonte e inquotável para cada assistente lendo a página.
collect_corpus_map Cada página com seu tamanho, contagem de cabeçalhos e profundidade, as seções, os stubs e quanto disso a navegação alcança.
collect_assistant_questions O que os leitores perguntaram ao seu assistente de docs, palavra por palavra, o que disso ficou sem resposta, a taxa de resposta com seu denominador e os idiomas em que chegou.
collect_traffic Quem chegou, como as visitas terminaram, em quais páginas elas terminaram e as sequências de 2 a 4 páginas que os leitores percorrem — quatro tabelas, mantidas separadas.
collect_onsite_search O que os leitores digitavam na sua própria caixa de pesquisa, o que não retornou nada e o que retornou resultados e não recebeu cliques — três tabelas, mantidas separadas, porque a primeira é uma página ausente e a segunda é um título perdedor.

Não há modelo no caminho, então não há nada neles para desacreditar — e a carga prova isso em vez de reivindicá-lo. Cada resposta carrega um reproduce bloco: as chamadas MCP exatas e os argumentos com os quais foram feitas, por linha. Execute-as você mesmo e você obterá o mesmo registro de volta, exceto pelo timestamp. Nada que uma auditoria retorna pode oferecer isso, porque a resposta de uma auditoria passou por um modelo.

O que você não obtém é um julgamento. Nenhuma descoberta, nenhuma pontuação, nenhuma classificação, nenhuma recomendação — essas são o que o preço de uma ferramenta de ação compra, e um coletor que silenciosamente incluísse um seria uma execução de agente a uma fração do preço.

Quando o barato é o certo. Sem o Search Console conectado, measure_intent_match pontua seus eixos de classificação como não medidos e ainda cobra pela execução; collect_corpus_map não precisa de dados de pesquisa, tráfego e nenhuma história, e devolve linhas reais em um site que subiu esta manhã. O mesmo se aplica quando você quer os números sobre os quais uma ação foi construída antes de decidir se deve comprar a leitura deles.

O que está faltando é dito em voz alta. Uma fonte que não pôde ser lida aparece três vezes — em skipped, em unavailable com o que tê-la teria adicionado, e em sua própria linha reproduce com a razão pela qual falhou. Uma taxa com nada para dividir volta como null com a razão, nunca como um zero, e cada taxa carrega seu denominador.

Lendo os números honestamente#

Cada resposta de análise do servidor Docsbook MCP traz suas próprias ressalvas em um campo metrics. Três são importantes o suficiente para serem repetidas:

  • Visitantes são IPs hash. O NAT do escritório combina vários leitores em um; redes móveis dividem um leitor em muitos. Relate tendências, nunca contagens — get_retention é o mais afetado.
  • Taxas são retidas abaixo de 30 visitas, e dias fracos são sinalizados thin. Uma taxa de 100% de ponto morto em quatro visitas é ruído.
  • terminal_success não é uma falha. Uma página da qual as pessoas saem após copiar um trecho é a melhor página que você tem. Todas as ferramentas de classificação isentam essas — não reintroduza o erro manualmente.

Como pesquiso e edito o conteúdo da documentação a partir de um agente?#

Há duas maneiras de trabalhar com o conteúdo da sua documentação a partir de um agente, e a escolha depende de o agente ter ou não o repositório no disco:

  • Hospedado, via tokens MCPsearch_docs (somente leitura; funciona com qualquer token conectado, independentemente do escopo), get_doc_outline (somente leitura; lista o título, a quantidade de cabeçalhos e o tamanho de cada página Markdown antes de pesquisar ou gravar) e write_docs (requer um token autorizado com escopo de leitura e gravação; confirma um ou mais arquivos como um único commit atômico do git). Eles atuam diretamente no repositório hospedado pelo Docsbook, sem precisar de um checkout local.
  • Localmente, via markdown-lsp — para um agente que trabalha diretamente nos arquivos cujo checkout foi feito, markdown-lsp responde a consultas de grafo mais avançadas (estrutura geral do workspace, pesquisa difusa de cabeçalhos, texto completo com contexto, links de entrada e saída, resolução de links) como comandos executados pelo agente — npx markdown-lsp <subcommand> ./docs — ou como um servidor de linguagem. Ele não é um servidor MCP e não requer token. Consulte Fonte da verdade para ver a lista de subcomandos e a justificativa.

Use search_docs/write_docs quando o agente tiver apenas uma conexão MCP (sem checkout local); use markdown-lsp quando o agente já tiver o repositório no disco e quiser uma navegação mais aprofundada pelo grafo.

Em que se baseia uma chamada ao servidor MCP do Docsbook?#

Cada chamada tarifada ao servidor MCP do Docsbook é debitada do saldo do projeto ao qual a chamada se refere — o mesmo saldo que um carregamento abastece e do qual o restante do trabalho de IA desse projeto também é debitado. Não há um medidor separado para o MCP nem uma cota mensal de chamadas a considerar. O dinheiro é o único limite.

Uma chamada é cobrada por um valor fixo, definido antes de ser executada e independente do tamanho da resposta. A mesma chamada de relatório tem o mesmo custo em um site com dez páginas e em um com dez mil. O que determina o valor é o que o atendimento da chamada faz o servidor executar:

Classe O que a chamada faz o servidor executar Ferramentas incluídas
Incluída Nada além de uma consulta get_info, find_skill, find_widget, list_workspaces, get_workspace, create_workspace
Leitura Lê uma linha que já armazena Uma página, uma configuração ou uma linha do registro — a classe à qual uma ferramenta não classificada pertence
Escrita Altera o estado armazenado create_*, update_*, set_*, delete_*, register_*, unregister_*, upload_*, approve_*, mark_*
Análise Examina o armazenamento de eventos Funis, jornadas, retenção, classificações, feeds, query_events
Saída Sai da rede do Docsbook fetch_url, read_source, test_*, replay_*, as quatro leituras de rastreadores (list_issues, get_issue, get_pull_request, search_prior_work) e as ferramentas de scraping fornecidas por terceiros
Sondagem Reúne e normaliza uma família de fatos, sem envolver um modelo collect_*
IA Chama um modelo para escrever, ler ou classificar write_docs, search_docs, search, get_insights, get_chat_intent
Lente Uma passagem de modelo sobre um registro de evidências que recebeu, relido a partir de um único ângulo declarado Reservada (lens_*) — atualmente nenhuma ferramenta pertence a esta classe
Agente Executa um agente completo por trás de uma única chamada As 135 ferramentas de ação (observe_*, explain_*, discover_*, decide_*, plan_*, draft_*, measure_*, verify_*, learn_*, handoff_*), os 41 objetivos agent_*, além de audit_geo, generate_issues e run_docs_*

O preço de uma ferramenta de ação é calculado a partir do trabalho que ela declara — quantas famílias de evidências ela lê, quantas idas e voltas ao modelo pode fazer, se sai do seu site, se grava um artefato — em vez de um valor único para toda a classe. Assim, uma observação restrita custa uma fração do que custa um rascunho aprofundado, e seu tempo de espera publicado (aproximadamente de 20 s a 70 s) varia da mesma forma.

O valor atual de cada classe e de cada ferramenta individual está na própria linha da ferramenta na seção MCP do seu painel de administração, lido diretamente do servidor em vez de uma cópia escrita, e na página de preços do Docsbook. Esta página deliberadamente não informa nenhum dos dois: um preço copiado para a documentação é um preço que fica desatualizado sem que ninguém perceba.

A descoberta nunca é tarifada. Descrever o servidor, encontrar uma habilidade ou um widget, listar seus espaços de trabalho e criar um deles não custa nada — você não deve ser cobrado pelo handshake nem pela chamada que cria o item que será cobrado.

Qual projeto paga é determinado pela própria chamada — o espaço de trabalho que você indicou, o repositório ao qual ela está vinculada — e sempre apenas um projeto que você possui. Uma chamada que não indica nenhum projeto é atendida sem tarifação. Uma ferramenta que prossegue para realizar trabalho de IA também gera cobrança por esse trabalho; as duas cobranças são somadas, não substituídas.

Quando o saldo acaba, uma chamada tarifada é recusada antes de ser executada, e a recusa informa qual projeto ficou sem saldo, quanto a chamada consumiria, quanto resta e onde recarregar esse projeto. Nada é concedido a um saldo segundo um cronograma, embora você possa configurar um pagamento mensal próprio na tela de cobrança, que recarrega o mesmo saldo todos os meses. A descoberta gratuita continua funcionando, para que seu agente ainda possa descobrir o que aconteceu.

Uma chamada que falha ainda é cobrada — o trabalho foi realizado, e a resposta informa isso. Uma chamada que o servidor nunca conseguiu executar não é cobrada.

Você pode ler as chamadas linha por linha. Cada chamada tarifada aparece no painel de Feeds do projeto — qual ferramenta foi usada, se funcionou, quanto tempo levou e quanto consumiu — com filtro por classe de cobrança. As chamadas que não se referiam a um único projeto (descrever o servidor, listar seus projetos, criar um deles) pertencem à sua conta e não aparecem no feed de nenhum projeto; as chamadas de descoberta não deixam nenhuma linha.

O acesso não autenticado e vinculado a um repositório a um site público de documentação nunca é tarifado.

O que um token pode fazer#

O acesso ao servidor MCP do Docsbook é decidido pelo token, não por um nível. Um token carrega um escopo, e o escopo é a única coisa que diferencia leitura de escrita:

  • Somente leitura — todas as ferramentas de relatórios, pesquisa e estrutura respondem. write_docs, create_issue, connect_source, configure_source, enable_agent e as três execuções de escrita de run_docs_* recusam a solicitação e informam o motivo. Essas oito são as ferramentas que atualmente verificam o escopo; as ferramentas de configurações, webhook, metas e tradução são protegidas apenas pela propriedade do projeto, portanto, somente leitura não é um token que "não altera nada" — consulte Segurança do servidor MCP.
  • Leitura e escrita — tudo o que a conta pode fazer: confirmar páginas, registrar problemas, conectar fontes, ativar agentes e alterar configurações.
  • Nenhum token — em um endpoint com escopo de repositório (docsbook.io/{owner}/{repo}/api/mcp/server), get_info, find_skill, find_widget e list_content_widgets respondem a partir do catálogo público, e search responde usando a própria documentação desse site — a única ferramenta aqui que lê um projeto, pois o que ela lê é o site publicado. Ela é recusada em um site privado, em um site cujo plano expirou, em um endpoint não fixado a um site e quando o projeto não tem mais saldo de IA; ela não aceita um argumento de projeto, portanto só pode ler o site ao qual está fixada. Todas as outras ferramentas exigem um token Bearer válido vinculado a uma conta do Docsbook.

Quando uma chamada é recusada, o servidor retorna um erro estruturado informando o motivo, em vez de um 403 simples, para que o agente possa dizer ao leitor o que corrigir. Consulte Servidor MCP — Confiança & Segurança para saber mais sobre o fluxo de autenticação e o que o servidor armazena.

  • Referência das ferramentas MCP — todas as ferramentas com seus parâmetros.
  • Ganchos de chat — configure ganchos pré/pós-LLM via MCP.
  • Habilidades de documentação — descubra arquivos SKILL.md por meio de find_skill ou faça com que um seja executado por você com run_docs_*.
  • Webhooks — registre manipuladores de eventos do MCP e verifique suas assinaturas.
  • Preços — o que uma chamada tarifada utiliza, gerado a partir das constantes de faturamento em tempo real.

Updated

Esta página foi útil?