Plugin System

// ~/.conductor/plugins/planetscale.js
// A complete plugin example with credentials, error handling, and multiple tools

export default class PlanetScalePlugin {
  name = "planetscale";
  description = "Query PlanetScale databases via the PS API";
  version = "1.0.0";

  #apiKey = null;
  #orgName = null;
  #baseUrl = "https://api.planetscale.com/v1";

  configSchema = {
    fields: [
      {
        key: "apiKey",
        label: "Service Token",
        type: "string",
        secret: true,     // stored in encrypted credential store
        required: true,
        hint: "Create at app.planetscale.com/settings/service-tokens",
      },
      {
        key: "orgName",
        label: "Organization name",
        type: "string",
        required: true,
      },
    ],
  };

  async initialize(conductor) {
    this.#apiKey = await conductor.config.getSecret("planetscale.apiKey");
    this.#orgName = await conductor.config.get("planetscale.orgName");
    this.logger = conductor.logger;
  }

  isConfigured() {
    return !!this.#apiKey && !!this.#orgName;
  }

  getTools() {
    return [
      {
        name: "planetscale_databases",
        description: "List all databases in your organization",
        inputSchema: { type: "object", properties: {} },
        handler: async () => this.#listDatabases(),
      },
      {
        name: "planetscale_branches",
        description: "List branches for a database",
        inputSchema: {
          type: "object",
          properties: {
            database: { type: "string", description: "Database name" },
          },
          required: ["database"],
        },
        handler: async ({ database }) => this.#listBranches(database),
      },
      {
        name: "planetscale_query",
        description: "Run a read-only SQL query",
        inputSchema: {
          type: "object",
          properties: {
            database: { type: "string" },
            branch: { type: "string", default: "main" },
            sql: { type: "string", description: "SELECT statement" },
          },
          required: ["database", "sql"],
        },
        handler: async ({ database, branch = "main", sql }) => {
          if (!sql.trim().toUpperCase().startsWith("SELECT")) {
            throw new Error("Only SELECT queries are permitted");
          }
          return this.#runQuery(database, branch, sql);
        },
      },
    ];
  }

  async #request(path) {
    const res = await fetch(`${this.#baseUrl}/${path}`, {
      headers: {
        Authorization: `Bearer ${this.#apiKey}`,
        Accept: "application/json",
      },
    });
    if (!res.ok) throw new Error(`PlanetScale API error: ${res.status}`);
    return res.json();
  }

  async #listDatabases() {
    const data = await this.#request(
      `organizations/${this.#orgName}/databases`
    );
    return {
      content: [{ type: "text", text: JSON.stringify(data.data, null, 2) }],
    };
  }

  async #listBranches(database) {
    const data = await this.#request(
      `organizations/${this.#orgName}/databases/${database}/branches`
    );
    return {
      content: [{ type: "text", text: JSON.stringify(data.data, null, 2) }],
    };
  }

  async #runQuery(database, branch, sql) {
    this.logger.info(`Querying ${database}/${branch}`);
    // implementation omitted for brevity
    return { content: [{ type: "text", text: "..." }] };
  }
}

conductor plugins enable planetscale
conductor plugins setup planetscale