get-pipeline-service
Retrieves pipeline service details using its fully qualified name. Accepts optional fields and deleted status filters.
Instructions
Get pipeline service by name
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fqn | Yes | Service fully qualified name | |
| fields | No | ||
| include | No |
Implementation Reference
- src/tools/services.ts:114-117 (handler)The handler function for 'get-pipeline-service' tool. It destructures 'fqn' (fully qualified name) from params and makes a GET request to /services/pipelineServices/name/{fqn}.
export async function getPipelineService(params: z.infer<typeof getPipelineServiceSchema>) { const { fqn, ...query } = params; return omClient.get(`/services/pipelineServices/name/${encodeURIComponent(fqn)}`, query); } - src/tools/services.ts:19-23 (schema)The input schema for 'get-pipeline-service'. Defines required 'fqn' (fully qualified name) and optional 'fields' and 'include' parameters.
const getByNameParams = z.object({ fqn: z.string().describe("Service fully qualified name"), fields: z.string().optional(), include: z.enum(["non-deleted", "deleted", "all"]).optional(), }); - src/index.ts:231-231 (registration)Registration of the 'get-pipeline-service' tool on the MCP server with its schema and wrapped handler.
tool("get-pipeline-service", "Get pipeline service by name", getPipelineServiceSchema.shape, wrapToolHandler(getPipelineService)); - src/tools/services.ts:1-3 (helper)Imports used by getPipelineService: zod for schema validation and omClient for HTTP requests.
import { z } from "zod/v4"; import { omClient } from "../client.js"; import { assertWriteAllowed } from "./utils.js"; - src/tools/services.ts:113-113 (schema)Assignment of getByNameParams as getPipelineServiceSchema, used for input validation.
export const getPipelineServiceSchema = getByNameParams;