Skip to main content
REST client

Servers

The 4 operations under servers, as typed calls on the generated REST client.

1 min read
View MarkdownEdit on GitHub

Servers

Available from @codespar/sdk 0.12.0, which is not on npm yet. The published version today is 0.11.0, and it has no cs.api; 0.12.0 is on the main branch of codespar-core. The examples below are not compiled against the installed package for that reason.

Every call below is cs.api reaching one operation of the OpenAPI document this page was generated from; the REST client overview explains request, response, the option bag and the errors. The values are placeholders shaped by the document.

import { CodeSpar } from "@codespar/sdk";

const cs = new CodeSpar({ apiKey: process.env.CODESPAR_API_KEY });

GET /v1/servers

GET/v1/servers
Deprecated

List the MCP servers this project can attach to a session

const result = await cs.api.get("/v1/servers");

Parameters, body and every documented response: GET /v1/servers in the HTTP reference.

GET /v1/servers/{id}/auth-schema

GET/v1/servers/{id}/auth-schema

Read the credential form a provider needs, without reading any credential

const result = await cs.api.get("/v1/servers/{id}/auth-schema", {
  path: {
    id: "srv_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/servers/{id}/auth-schema in the HTTP reference.

GET /v1/servers/{id}/tools

GET/v1/servers/{id}/tools

List the tools a provider exposes

const result = await cs.api.get("/v1/servers/{id}/tools", {
  path: {
    id: "srv_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/servers/{id}/tools in the HTTP reference.

POST /v1/servers/{id}/verify-connection

POST/v1/servers/{id}/verify-connection

Ask the provider whether this project's stored credential still works

const result = await cs.api.post("/v1/servers/{id}/verify-connection", {
  path: {
    id: "srv_0000000000000000"
  }
});

Parameters, body and every documented response: POST /v1/servers/{id}/verify-connection in the HTTP reference.

Servers | CodeSpar