report.api.md

API Report File for "@red-hat-developer-hub/backstage-plugin-lightspeed-backend"

Do not edit this file. It is a report generated by API Extractor.

import type { AuthService } from '@backstage/backend-plugin-api';
import { BackendFeature } from '@backstage/backend-plugin-api';
import type { Config } from '@backstage/config';
import type { DatabaseService } from '@backstage/backend-plugin-api';
import express from 'express';
import type { HttpAuthService } from '@backstage/backend-plugin-api';
import type { LoggerService } from '@backstage/backend-plugin-api';
import type { PermissionsService } from '@backstage/backend-plugin-api';
import type { UserInfoService } from '@backstage/backend-plugin-api';

// @public
export function createRouter(options: RouterOptions): Promise<express.Router>;

// @public
const lightspeedPlugin: BackendFeature;
export default lightspeedPlugin;

// @public
export type McpServerAuth = 'dcr';

// @public
export interface McpServerResponse {
  auth?: McpServerAuth;
  // (undocumented)
  enabled: boolean;
  // (undocumented)
  hasToken: boolean;
  // (undocumented)
  hasUserToken: boolean;
  // (undocumented)
  name: string;
  // (undocumented)
  status: McpServerStatus;
  // (undocumented)
  toolCount: number;
  // (undocumented)
  url?: string;
}

// @public (undocumented)
export type McpServerStatus = 'connected' | 'error' | 'unknown';

// @public (undocumented)
export interface McpToolInfo {
  // (undocumented)
  description: string;
  // (undocumented)
  name: string;
}

// @public (undocumented)
export interface McpValidationResult {
  // (undocumented)
  error?: string;
  // (undocumented)
  toolCount: number;
  // (undocumented)
  tools: McpToolInfo[];
  // (undocumented)
  valid: boolean;
}

// @public
export type RouterOptions = {
  logger: LoggerService;
  config: Config;
  database: DatabaseService;
  httpAuth: HttpAuthService;
  userInfo: UserInfoService;
  permissions: PermissionsService;
  auth: AuthService;
};

// (No @packageDocumentation comment for this package)