NocoDB

Servidor MCP NocoDB

Introdução

O Servidor MCP NocoDB permite interação perfeita com seu banco de dados NocoDB usando o Protocolo de Contexto de Modelo (MCP). Este servidor facilita operações CRUD (Criar, Ler, Atualizar, Excluir) em tabelas NocoDB por meio de comandos em linguagem natural.

Exemplo de Prompt

[Get Records]
get data from nocodb, table: Shinobi

[Create Record]
add new row, with name: sasuke-2
add other row, with name: naruto-2

[Update Record]
update all rows, remove suffix -

[Delete Record]
delete all rows with name naruto

[Add Column]
add column with name: Age

update all rows, set Age to 18

[Delete Column]
delete column with name: Age

Exemplo de Prompt - Upload de Arquivo

[Create table]
from the json files
put on nocodb database
table name is TableShinobi

Arquivo de localização JSON em: example_upload.json

Exemplo de Prompt - Criar Registros em Massa e Excluir Registros em Massa

Sobre Este Fork

Este repositório é um fork baseado em TypeScript do NocoDB-MCP-Server. Ele mantém a funcionalidade principal enquanto melhora a manutenibilidade e a compatibilidade com práticas modernas de desenvolvimento TypeScript.

Implantação Hospedada

Uma implantação hospedada está disponível na Fronteir AI.

Configuração

Certifique-se de que Node.js e TypeScript estejam instalados e, em seguida, execute:

npm install
npm run build

Configuração

Defina as variáveis de ambiente necessárias em um arquivo .env:

NOCODB_URL=https://your-nocodb-instance.com
NOCODB_API_TOKEN=your_api_token_here
NOCODB_BASE_ID=your_base_id_here

Dica: Você pode copiar o modelo de env.example e preencher com seus valores.

Como Obter NOCODB_BASE_ID

Para encontrar seu NOCODB_BASE_ID, verifique a URL da sua instância Nocodb.
Por exemplo: https://app.nocodb.com/#/wi6evls6/pqmob3ammcknma5/maty9c5xkmf4012
Neste formato de URL:

https://app.nocodb.com/#/{USERNAME}/{NOCODB_BASE_ID}/{TABLE_ID}

Integração com Claude Desktop

Modifique claude_desktop_config.json para incluir:

{
  "mcpServers": {
    "nocodb": {
      "command": "node",
      "args": ["{working_folder}/dist/start.js"],
      "env": {
        "NOCODB_URL": "https://your-nocodb-instance.com",
        "NOCODB_BASE_ID": "your_base_id_here",
        "NOCODB_API_TOKEN": "your_api_token_here"
      }
    }
  }
}

Chamada direta pela CLI

Você pode chamar diretamente o servidor MCP pela linha de comando:
NOCODB_URL, NOCODB_API_TOKEN e NOCODB_BASE_ID são parâmetros obrigatórios.
NOCODB_URL=https://app.nocodb.com se você estiver usando o NocoDB na nuvem.

npx -y nocodb-mcp-server {NOCODB_URL} {NOCODB_BASE_ID} {NOCODB_API_TOKEN} 

Testando a CLI

Para executar os testes, execute:

npx -y @wong2/mcp-cli npx nocodb-mcp-server {NOCODB_URL} {NOCODB_BASE_ID} {NOCODB_API_TOKEN} 

Funções da API

Para informações detalhadas sobre as funções da API disponíveis, consulte API_FUNCTION.md.

Estrutura do Projeto

/project-root
  ├── src/            # TypeScript source files
  ├── dist/           # Compiled JavaScript output
  ├── .env            # Environment variable configurations
  ├── package.json    # Project dependencies and scripts
  ├── tsconfig.json   # TypeScript settings

Diretrizes de Contribuição

Contribuições são bem-vindas! Sinta-se à vontade para abrir issues ou enviar pull requests.

Licença

Este projeto é distribuído sob a licença MIT.