PipeCD Docs

Servidor MCP de Documentação do PipeCD

Um servidor MCP local para pesquisar a documentação oficial do PipeCD.

Visão Geral

Este servidor clona a documentação oficial do PipeCD do GitHub e fornece APIs simples de busca em texto completo e recuperação de documentos via o protocolo MCP.
A documentação é clonada em um diretório temporário, e os arquivos Markdown são indexados extraindo seus títulos e conteúdos.

Uso

Pré-requisitos

1. Crie um PAT com o escopo read:packages. Detalhes

2. Adicione a seguinte configuração ao seu arquivo .npmrc.

@pipe-cd:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=YOUR_TOKEN

Cursor

Instalação Rápida com Deeplink do Cursor

Para usuários do Cursor, você pode instalar o servidor MCP com um único clique usando o deeplink abaixo:

Isso configurará automaticamente o servidor MCP nas configurações do seu Cursor. Após clicar no link, o Cursor solicitará que você instale o servidor.

Instalação Usando npx

Adicione a seguinte configuração ao seu mcp.json.

{
  "mcpServers": {
    "pipe-cd.docs-mcp-server": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "@pipe-cd/docs-mcp-server@latest"
      ], 
    }
  }
}

Ferramentas

search_docs

Executa uma busca em texto completo na documentação do PipeCD.

• Parâmetros:
  • query: Palavras-chave de busca (separadas por espaços, busca AND)
  • offset: Posição inicial para os resultados
  • limit: Número de resultados a retornar (padrão: 20)

read_docs

Retorna o conteúdo da página especificada.

• Parâmetros:
  • path: Caminho relativo do documento (após "docs/content/en/")

Notas de Implementação

• Usa sparse-checkout para minimizar o tamanho do clone e acelerar o processo.
• Os títulos são extraídos do front matter do Markdown.
• A lógica de busca do search_docs é muito simples por enquanto.

Contribuindo

Código de Conduta

O PipeCD segue o Código de Conduta do CNCF. Por favor, leia-o para entender quais ações são aceitáveis e quais não são.

Participe

• Slack: canal #pipecd no Slack do CNCF para discussões relacionadas ao desenvolvimento do PipeCD.
• Reunião da Comunidade: A cada duas quartas-feiras. Pesquise aqui.

Melhorias

• Bug:
  • Por favor, abra uma Issue e descreva o problema. Ou, abra um PR se for algo simples.
• Melhoria / Solicitação de Recurso:
  • Para mudanças pequenas, incluindo documentação ou adição de testes, por favor, abra um PR.
  • Para novos recursos ou grandes melhorias, basicamente, por favor, abra uma Issue e discuta antes de enviar um PR. Não podemos aceitar todas as solicitações em alguns casos.
• Problema de segurança:
  • Envie um e-mail para os mantenedores principais. NÃO relate em Issues.

Fluxo de Lançamento

1. Execute o workflow prepare release especificando a nova versão. Ele criará um PR para atualizar a versão.
2. Revise o PR e faça o merge.
3. Crie um Release no GitHub com uma nova tag. Então, o workflow release package publicará um novo pacote npm.