Documentação

Configuração do MCP

Configuração de conexão MCP CRUD e solicitações de informações do servidor.

Traduzido automaticamente do inglês. Ver o original em inglês

Área de testes

Envie essas solicitações para seu próprio sidecar em execução. Os valores permanecem neste navegador.

Não conectado

URL base Token do portador opcional Token de sessão opcional

Como isso funciona

O sidecar escuta em uma porta de loopback escolhida na inicialização e a imprime em seu ready linha; use esse URL e o CADCAMFUN_TOKEN foi iniciado. As solicitações vão direto desta página para esse endereço.

O sidecar envia cabeçalhos CORS apenas para as origens Tauri e para http://localhost ou http://127.0.0.1 em qualquer porto. Nos documentos hospedados, o navegador bloqueia a resposta, então execute os documentos localmente (bun run dev em packages/web) para usar o playground ou copie a solicitação como curl. Para experimentar sem tocar em dados reais, inicie o sidecar com CADCAMFUN_DATA_DIR apontado para um diretório descartável - veja o passo a passo da API.

Operações

8 endpoints no mcp grupo, gerado a partir do próprio sidecar Documento OpenAPI. As operações protegidas levam Authorization: Bearer $CADCAMFUN_TOKEN; ver autenticação. Comportamento e limites estão em o guia do subsistema.

pegar	/api/mcp/config	mcp.listConfig
publicar	/api/mcp/config	mcp.createConfig
colocar	/api/mcp/config	mcp.updateConfig
excluir	/api/mcp/config	mcp.removeConfig
pegar	/api/mcp/config/{id}	mcp.getConfig
colocar	/api/mcp/config/{id}	mcp.updateConfigById
excluir	/api/mcp/config/{id}	mcp.removeConfigById
publicar	/api/mcp/server-info	mcp.serverInfo

Operações de configuração do MCP em 3D Arraste para orbitar · role para ampliar · arraste com o botão direito para deslocar

Um bloco por operação (8), empilhado por seção de recursos desta página e colorido por método: verde GET, laranja POST, azul PUT, violeta PATCH, vermelho DELETE. Gerado a partir do documento OpenAPI em tempo de construção.

/api/mcp/config

pegar /api/mcp/config # mcp.listConfig

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
fonte	consulta	corda \| null	opcional

Respostas

200 objeto | objeto application/json

{
  success: true
  source: "claude" | "database"
  servers: Array<{
    id: string
    name: string
    type: string
    url: string | null
    command: string | null
    args: unknown
    workingDirectory: string | null
    enabled: boolean
    userId: string | null
    createdAt: string
    updatedAt: string
  }>
  count: number | "Infinity" | "-Infinity" | "NaN"
} | {
  success: true
  source: "file"
  config: {
    mcpServers: Array<{
      id: string
      name: string
      type: string
      url: string | null
      command: string | null
      args: unknown
      workingDirectory: string | null
      enabled: boolean
    }>
  }
  exportedAt: string
}

400 McpEnvBadRequestEncoded application/json

McpEnvBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 McpEnvInternalEncoded application/json

McpEnvInternalEncoded

Resposta de exemplo capturado · 200

OBTER /api/mcp/config

{
  "success": true,
  "source": "claude",
  "servers": [],
  "count": 0
}

Exemplo de SDK

mcp.listConfig

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// McpListConfigInput
const result = await client.mcp.listConfig({})

curl

OBTER /api/mcp/config

curl --request GET "${CADCAMFUN_URL}/api/mcp/config" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Experimente

fonte consulta

publicar /api/mcp/config # mcp.createConfig

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
fonte	consulta	corda \| null	opcional

Corpo da solicitação · obrigatório · aplicação/json

{
  id?: string | null
  name?: string | null
  type?: string | null
  url?: string | null
  command?: string | null
  args?: unknown | null
  workingDirectory?: string | null
  defaultWorkingDirectory?: string | null
  enabled?: boolean | null
  serverName?: string | null
  testConnection?: boolean | null
  mcpServers?: unknown | null
  tool_configuration?: unknown | null
  authorization_token?: string | null
}

Respostas

200 objeto application/json

{
  success: true
  source: "file"
  imported: number | "Infinity" | "-Infinity" | "NaN"
  message: string
}

201 objeto application/json

{
  success: true
  source: "claude" | "database"
  server: {
    id: string
    name: string
    type: string
    url: string | null
    command: string | null
    args: unknown
    workingDirectory: string | null
    enabled: boolean
    userId: string | null
    createdAt: string
    updatedAt: string
  }
  connectionTest?: unknown | null
  message: string
}

400 McpEnvBadRequestEncoded application/json

McpEnvBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 McpEnvInternalEncoded application/json

McpEnvInternalEncoded

buscar exemplo

mcp.createConfig

// Not generated in the Promise SDK (multipart, binary or raw body): call it with fetch.
const response = await fetch(`${process.env.CADCAMFUN_URL}/api/mcp/config`, {
  method: "POST",
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

curl

POST /api/mcp/config

curl --request POST "${CADCAMFUN_URL}/api/mcp/config" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Experimente

fonte consulta

Solicitar corpo application/json

colocar /api/mcp/config # mcp.updateConfig

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
fonte	consulta	corda \| null	opcional

Corpo da solicitação · obrigatório · aplicação/json

{
  id?: string | null
  name?: string | null
  type?: string | null
  url?: string | null
  command?: string | null
  args?: unknown | null
  workingDirectory?: string | null
  defaultWorkingDirectory?: string | null
  enabled?: boolean | null
  serverName?: string | null
  testConnection?: boolean | null
  mcpServers?: unknown | null
  tool_configuration?: unknown | null
  authorization_token?: string | null
}

Respostas

200 objeto application/json

{
  success: true
  source: "claude"
  server: {
    id: string
    name: string
    type: string
    url: string | null
    command: string | null
    args: unknown
    workingDirectory: string | null
    enabled: boolean
    userId: string | null
    createdAt: string
    updatedAt: string
  }
  message: string
}

400 McpEnvBadRequestEncoded application/json

McpEnvBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 McpEnvNotFoundEncoded application/json

McpEnvNotFoundEncoded

405 McpEnvMethodNotAllowedEncoded application/json

McpEnvMethodNotAllowedEncoded

500 McpEnvInternalEncoded application/json

McpEnvInternalEncoded

Exemplo de SDK

mcp.updateConfig

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// McpUpdateConfigInput
const result = await client.mcp.updateConfig({
  id: "",
  name: "",
  type: "",
  url: "",
  command: "",
  args: null,
  workingDirectory: "",
  defaultWorkingDirectory: "",
  enabled: false,
  serverName: "",
  testConnection: false,
  mcpServers: null,
  tool_configuration: null,
  authorization_token: ""
})

curl

COLOQUE /api/mcp/config

curl --request PUT "${CADCAMFUN_URL}/api/mcp/config" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Experimente

fonte consulta

Solicitar corpo application/json

excluir /api/mcp/config # mcp.removeConfig

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
fonte	consulta	corda \| null	opcional
nome	consulta	corda \| null	opcional

Respostas

200 objeto application/json

{
  success: true
  source: "claude"
  message: string
  note: string
}

400 McpEnvBadRequestEncoded application/json

McpEnvBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 McpEnvNotFoundEncoded application/json

McpEnvNotFoundEncoded

405 McpEnvMethodNotAllowedEncoded application/json

McpEnvMethodNotAllowedEncoded

500 McpEnvInternalEncoded application/json

McpEnvInternalEncoded

Exemplo de SDK

mcp.removeConfig

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// McpRemoveConfigInput
const result = await client.mcp.removeConfig({})

curl

DELETE /api/mcp/config

curl --request DELETE "${CADCAMFUN_URL}/api/mcp/config" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Experimente

fonte consulta nome consulta

pegar /api/mcp/config/{id} # mcp.getConfig

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
eu ia	caminho	corda	obrigatório

Respostas

200 objeto application/json

{
  id: string
  name: string
  type: string
  url: string | null
  command: string | null
  args: unknown
  workingDirectory: string | null
  enabled: boolean
  userId: string | null
  createdAt: string
  updatedAt: string
}

400 McpBadRequestEncoded application/json

McpBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 McpNotFoundEncoded application/json

McpNotFoundEncoded

500 McpInternalEncoded application/json

McpInternalEncoded

Exemplo de SDK

mcp.getConfig

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// McpGetConfigInput
const result = await client.mcp.getConfig({
  id: "<id>"
})

curl

OBTER /api/mcp/config/{id}

curl --request GET "${CADCAMFUN_URL}/api/mcp/config/<id>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Experimente

eu ia caminho · obrigatório

colocar /api/mcp/config/{id} # mcp.updateConfigById

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
eu ia	caminho	corda	obrigatório

Corpo da solicitação · obrigatório · aplicação/json

{
  id?: string | null
  name?: string | null
  type?: string | null
  url?: string | null
  command?: string | null
  args?: unknown | null
  workingDirectory?: string | null
  defaultWorkingDirectory?: string | null
  enabled?: boolean | null
  serverName?: string | null
  testConnection?: boolean | null
  mcpServers?: unknown | null
  tool_configuration?: unknown | null
  authorization_token?: string | null
}

Respostas

200 objeto application/json

{
  id: string
  name: string
  type: string
  url: string | null
  command: string | null
  args: unknown
  workingDirectory: string | null
  enabled: boolean
  userId: string | null
  createdAt: string
  updatedAt: string
}

400 McpBadRequestEncoded application/json

McpBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 McpNotFoundEncoded application/json

McpNotFoundEncoded

405 McpMethodNotAllowedEncoded application/json

McpMethodNotAllowedEncoded

500 McpInternalEncoded application/json

McpInternalEncoded

buscar exemplo

mcp.updateConfigById

// Not generated in the Promise SDK (multipart, binary or raw body): call it with fetch.
const response = await fetch(`${process.env.CADCAMFUN_URL}/api/mcp/config/${id}`, {
  method: "PUT",
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

curl

PUT /api/mcp/config/{id}

curl --request PUT "${CADCAMFUN_URL}/api/mcp/config/<id>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Experimente

eu ia caminho · obrigatório

Solicitar corpo application/json

excluir /api/mcp/config/{id} # mcp.removeConfigById

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
eu ia	caminho	corda	obrigatório

Respostas

204 <Sem conteúdo>

400 McpBadRequestEncoded application/json

McpBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 McpNotFoundEncoded application/json

McpNotFoundEncoded

405 McpMethodNotAllowedEncoded application/json

McpMethodNotAllowedEncoded

500 McpInternalEncoded application/json

McpInternalEncoded

Exemplo de SDK

mcp.removeConfigById

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// McpRemoveConfigByIdInput
const result = await client.mcp.removeConfigById({
  id: "<id>"
})

curl

DELETE /api/mcp/config/{id}

curl --request DELETE "${CADCAMFUN_URL}/api/mcp/config/<id>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Experimente

eu ia caminho · obrigatório

/api/mcp/server-info

publicar /api/mcp/server-info # mcp.serverInfo

Requer Authorization: Bearer <token>.

Corpo da solicitação · obrigatório · aplicação/json

{
  serverId?: string | null
}

Respostas

200 objeto application/json

{
  name: string
  version?: string | null
  instructions?: string | null
  resources?: Array<{
    name: string
    uriTemplate?: string | null
    description?: string | null
    arguments?: Array<{
      name: string
      description?: string | null
      required?: boolean | null
    }> | null
  }> | null
  tools?: Array<{
    name: string
    description?: string | null
    parameters?: unknown | null
  }> | null
}

400 McpBadRequestEncoded application/json

McpBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 McpNotFoundEncoded application/json

McpNotFoundEncoded

405 McpMethodNotAllowedEncoded application/json

McpMethodNotAllowedEncoded

500 McpInternalEncoded application/json

McpInternalEncoded

Exemplo de SDK

mcp.serverInfo

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// McpServerInfoInput
const result = await client.mcp.serverInfo({
  serverId: ""
})

curl

POST /api/mcp/server-info

curl --request POST "${CADCAMFUN_URL}/api/mcp/server-info" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Experimente

Solicitar corpo application/json

Esquemas

Esquemas nomeados acessíveis a partir dos parâmetros, corpos e respostas deste grupo. UM ? marca um campo opcional; | null marca um campo que pode estar presente com um valor nulo.

McpBadRequestEncoded

{
  _tag: "McpBadRequest"
  error: string
}

McpEnvBadRequestEncoded

{
  _tag: "McpEnvBadRequest"
  success: false
  error: string
}

McpEnvInternalEncoded

{
  _tag: "McpEnvInternal"
  success: false
  error: string
}

McpEnvMethodNotAllowedEncoded

{
  _tag: "McpEnvMethodNotAllowed"
  success: false
  error: string
}

McpEnvNotFoundEncoded

{
  _tag: "McpEnvNotFound"
  success: false
  error: string
}

McpInternalEncoded

{
  _tag: "McpInternal"
  error: string
}

McpMethodNotAllowedEncoded

{
  _tag: "McpMethodNotAllowed"
  error: string
}

McpNotFoundEncoded

{
  _tag: "McpNotFound"
  error: string
}

UnauthorizedEncoded

{
  _tag: "Unauthorized"
  message: string
}

Chamando este grupo

Os IDs de operação têm o formato mcp.<name>. O Promise SDK gerado (@cadcamfun/api/sdk) expõe a maioria deles como client.<namespace>.<method>(input), onde input é um objeto plano de parâmetros de caminho e campos de corpo; o exemplo do SDK de cada cartão mostra o acessador e o tipo de entrada exatos. Multipart uploads, respostas binárias ou JavaScript e webhooks brutos não são gerados; essas cartas mostram fetch em vez disso.

Erros do Promise SDK

import { CadCam, ClientError } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

try {
  await client.projects.list()
} catch (error) {
  if (error instanceof ClientError) {
    // Transport | UnexpectedStatus | UnsupportedContentType | MalformedResponse | SseEventTooLarge
  } else {
    // a declared error body: switch on error._tag
  }
}

Solução de problemas

Sintoma	Causa provável	Consertar
401 em cada chamada	Token de um lançamento anterior ou ausente `Bearer` prefixo	Enviar `Authorization: Bearer <token>` com o token com o qual o sidecar foi iniciado.
400 antes que algo aconteça	O corpo ou parâmetro não corresponde ao esquema	Compare a carga útil com o esquema de solicitação no cartão.
403 ou 404 em um registro que você vê em outro lugar	A conta atuante difere	Envie o certo `x-session-token`ou use o perfil local que possui o registro.
409	Estado conflitante, como um nome duplicado ou um cabeçalho de ramificação obsoleto	Leia novamente o recurso e tente novamente com os dados atuais.
Tente dizer "bloqueado pelo CORS"	Os documentos são veiculados a partir de uma origem sem loopback	Execute os documentos localmente ou copie a solicitação como curl.
Ligação recusada	O sidecar foi reiniciado em uma nova porta	Leia a porta do novo `ready` linha.