Servers

Available from @codespar/sdk 0.12.0; the version on npm is 0.16.18. When these docs build, the examples on this page are compiled against @codespar/sdk 0.16.18, the version this site installs: a call that does not type-check against it fails the build.

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

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

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

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

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

const r = await cs.api.response("post", "/v1/servers/{id}/verify-connection", {
  path: {
    id: "srv_0000000000000000"
  }
});
// r.status is one of the documented statuses (200, 403, 422),
// each with its own body shape in r.data; nothing here throws on 403.
if (r.ok) {
  console.log(r.data);
}

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