An astronaut overseeing a futuristic data hub
Baixar PDFVersão em Markdown

Conecte ReadMe ao ChatGPT, Claude e Gemini

Configure uma vez e funcione no ChatGPT, Claude, Cursor e em qualquer outro cliente que você goste. Tudo roda com segurança em segundo plano, para você relaxar e focar no que realmente importa. Transforme seu agente em um especialista técnico em segundos.

Pergunte à IA sobre este Connector

Desenvolvido, mantido e hospedado pela Vinkius.

MCP VERIFICADO · PRONTO PARA PRODUÇÃO · GARANTIA VINKIUS

Waiting for input…

Works with modern AI clients that support MCP, including ChatGPT, Claude, Cursor, and more.

ChatGPTClaudeCursorPerplexityGeminiMicrosoft CopilotRaycastMeta AI

A sua IA faz o trabalho. A gente cuida com segurança.

Nenhuma outra ferramenta de IA te dá isso. O seu workflow roda no cliente que você já ama, a sua conta fica protegida, e você decide o que o agente pode e não pode fazer. É a razão completa para mudar de vez.

Cada Connector vive dentro da nossa infraestrutura, no mesmo lugar onde o seu workflow roda. As três coisas abaixo já fazem parte dele, trabalhando silenciosamente em segundo plano para que você nunca precise pensar nelas. Nada para adicionar, nada para configurar, nada com que se preocupar.

A futuristic MCP client docking bay
V8 Isolate01

Cada Connector roda dentro do seu próprio ambiente lacrado.

Cada Connector roda em seu próprio runtime V8 lacrado — sem acesso aos seus arquivos, ao seu sistema ou a outros servidores. Um Connector nunca enxerga além da sua própria requisição.

Kill Switch02

Um interruptor para todos os agentes. Na hora.

Uma única ação desativa todos os Connectors, revoga todos os tokens e encerra todas as sessões de uma vez. A Governança de IA guarda o registro.

FinOps por usuário03

Limites de gastos que pausam em vez de assustar.

Cada usuário tem suas próprias conexões e credenciais, isoladas das dos demais. O que ultrapassar o seu limite de gastos fica aguardando a sua aprovação, em vez de ser cobrado.

Três controles, embutidos na camada pela qual sua IA se conecta.

Conjunto curado · 10 capacidades

Entregamos só as ações que importam.

Conjunto de capacidades01 / 03

01-04

4 capacidades neste conjunto.

Parte de 10 disponíveis através de ReadMe.

  1. 01

    Listar categorias

    Exibe todas as categorias de documentação disponíveis no ReadMe.

  2. 02

    Obter categoria

    Recupera os detalhes de uma categoria de documentação específica.

  3. 03

    Listar páginas customizadas

    Mostra todas as páginas personalizadas e independentes do projeto.

  4. 04

    Ler documento

    Extrai o conteúdo completo de uma página de documentação.

Conjunto de capacidades02 / 03

05-07

3 capacidades neste conjunto.

Parte de 10 disponíveis através de ReadMe.

  1. 05

    Listar documentos da categoria

    Lista todas as páginas de documentação contidas em uma categoria específica.

  2. 06

    Ver changelog

    Recupera o conteúdo completo de uma postagem específica do histórico de alterações.

  3. 07

    Pesquisar documentos

    Realiza buscas por texto completo em todas as páginas de documentação.

Conjunto de capacidades03 / 03

08-10

3 capacidades neste conjunto.

Parte de 10 disponíveis através de ReadMe.

  1. 08

    Listar changelogs

    Exibe a lista de todas as postagens de histórico de alterações.

  2. 09

    Ler página customizada

    Recupera o conteúdo integral de uma página personalizada.

  3. 10

    Ver detalhes do projeto

    Busca informações detalhadas sobre o projeto no ReadMe.

Trabalho real

O que as equipes executam de verdade

01

API Implementation

An engineer asks the AI to write a function based on the exact parameters found in the ReadMe API reference.

02

Documentation Audits

A writer uses the AI to find every mention of a deprecated endpoint across all pages.

03

Onboarding Support

A developer asks the AI to summarize the 'Getting Started' guide to understand the initial setup.

04

Product Update Sync

A team uses the AI to summarize recent changelogs to stay updated on new feature releases.

Automatize uma tarefa

Coloque ReadMe para trabalhar em uma coisa.

Automações passo a passo que sua IA executa por este Connector: o fluxo, os prompts para começar e as capabilities exatas por trás de cada passo.

Um connector, todas as IAs

ReadMe funciona com os clientes de IA mais populares.

Estes são os clientes mais populares, cada um com um guia passo a passo: um link, configurado uma vez, com governança e visibilidade embutidas. E como tudo roda no padrão MCP, a mesma conexão também funciona em qualquer outro cliente compatível — nada para reconstruir.

ClaudeClaudeChatGPTChatGPTGeminiGeminiPerplexityPerplexityGrokGrokMicrosoft CopilotMicrosoft CopilotCursorCursorVS CodeVS CodeWindsurfWindsurfJetBrainsJetBrainsClineClineLangChainLangChainVercel AI SDKVercel AI SDKLovableLovableZ.aiZ.aiRaycastRaycastQwen CodeQwen CodeKimi CodeKimi CodeLe ChatLe Chat

Construindo o seu próprio app? O connector é seu para usar.

Você não precisa de um cliente para colocar ReadMe para trabalhar: a mesma conexão hospedada entra nas suas aplicações e no código do seu agente, com a mesma governança em cada pedido. Construa com ele, converse com ele — uma conexão para os dois.

Observada, não estimada

Média de 853ms. Rápida em produção.

ReadMe é verificado diariamente contra o serviço em produção.

Média diáriaPico de 1110ms
3 de out.Hoje
Dia mais rápido
676ms
Dia mais lento
1110ms
Tendência de 14 dias
Desacelerando+5%

Conecte seu cliente

Uma URL. Todos os clientes.

Ative o Connector, copie seu link e cole no cliente que você já usa. 10 capacidades chegam prontas para rodar.

Acesso de prévia · não é autenticação no provedor

O token vk_preview_* pertence à infraestrutura de prévia da Vinkius. Ele permite que o Claude descubra e exiba as capacidades de ReadMe, para você ver a experiência dentro da sua IA.

Ele não autentica a sua conta com ReadMe. Ações que exigem credenciais ou dados reais da conta podem não ser executadas até que você ative o Connector e autorize o serviço.

ReadMe Connector

Tudo pronto. Escolha seu cliente MCP e siga as instruções de configuração.

Link do conectorhttps://edge.vinkius.com/vk_preview_65dP2ZEWi1ggQrtmq1IKVpZ6MOAhFxi6q98C5XwC/mcp

Claude Desktop

Siga os passos abaixo para conectar em segundos.

  1. 1In Claude Desktop, open Settings → Connectors.
  2. 2Click “Add custom connector” and paste the connector link above as the remote MCP server URL.
  3. 3Click Add and start a new chat — ReadMe capabilities are ready to use.
Configuração · claude_desktop_config.jsonCopiar
{
  "mcpServers": {
    "readme-mcp": {
      "url": "https://edge.vinkius.com/vk_preview_65dP2ZEWi1ggQrtmq1IKVpZ6MOAhFxi6q98C5XwC/mcp"
    }
  }
}
  • Claude
  • ChatGPT
  • Cursor
  • VS Code
  • Windsurf
  • Claude Code
  • JetBrains
  • Cline

Instruções passo a passo para cada cliente estão no guia. Como conectar

Configuração guiada para o Claude? Configurar ReadMe no Claude e outras IAs

Veja todos os clientes de IA com quem este connector funciona ↑

Para quem é

Feito para o trabalho que quem usa ReadMe delega.

Profissionais que precisam de acesso rápido e preciso a bases de conhecimento técnicas para acelerar o desenvolvimento e a escrita.

  • 01

    Developer Advocates

    Para verificar a precisão de guias publicados e redigir novos conteúdos baseados na estrutura existente.

  • 02

    Technical Writers

    Para pesquisar e auditar documentações atuais em busca de referências desatualizadas sem sair do editor de código.

  • 03

    Engenheiros de Software

    Para trazer a documentação oficial da API diretamente para a IDE, garantindo que o código siga os padrões publicados.

FAQ

Perguntas de quem usa ReadMe.

  • 01

    How do I connect my ReadMe docs to my AI?

    You connect the MCP via Vinkius and provide your ReadMe API Key, which you can find in your project's Configuration settings.

  • 02

    Which AI clients can use this MCP?

    This MCP works with any compatible client, including Claude, Cursor, Windsurf, and VS Code.

  • 03

    Can the AI see my private documentation?

    The AI can access any documentation that your provided ReadMe API Key has permission to view.

  • 04

    Does this work with API references?

    Yes, the AI can search and retrieve full content from your API reference pages.

  • 05

    Can I use this to check for recent updates?

    Yes, the MCP includes capabilities to list and retrieve the full content of your changelog posts.

  • 06

    Where do I obtain my ReadMe API Key?

    Log into your ReadMe dashboard. Navigate to your specific project, then open 'Configuration' and click on 'API Key'. You will use this key as the authentication parameter (our integration handles it natively as a Basic Auth username).

  • 07

    Does the server allow me to write or edit documentation?

    Currently, the MCP server is focused on read-only operations. It can query, retrieve, and search changelogs, custom pages, and standard documentation categories, bringing context to the AI securely without risking accidental overwrites.

  • 08

    In what format is the document content returned?

    All text and page content uses native Markdown format directly fetched from ReadMe's engine. This makes it perfect for the AI to interpret, syntax-highlight, and display naturally within chat or code comments.

Explore

Mais em Developer Tools

Sugestões

Conecte ReadMe ao Claude, Cursor, ChatGPT e outros