get-messaging-service
Retrieve a messaging service by providing its fully qualified name. Use optional fields and include parameters to filter results.
Instructions
Get messaging 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:101-104 (handler)The handler function that executes the 'get-messaging-service' tool logic. It destructures the 'fqn' parameter from the input, encodes it, and makes a GET request to the OpenMetadata API endpoint '/services/messagingServices/name/{fqn}'.
export async function getMessagingService(params: z.infer<typeof getMessagingServiceSchema>) { const { fqn, ...query } = params; return omClient.get(`/services/messagingServices/name/${encodeURIComponent(fqn)}`, query); } - src/tools/services.ts:19-23 (schema)The input schema for 'get-messaging-service'. Uses 'getByNameParams' which requires 'fqn' (service fully qualified name) and has 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/tools/services.ts:100-100 (schema)The exported schema constant 'getMessagingServiceSchema' which is assigned from 'getByNameParams'.
export const getMessagingServiceSchema = getByNameParams; - src/index.ts:226-226 (registration)Registration of the 'get-messaging-service' tool with the MCP server. Called with the tool name, description, the schema shape, and the wrapped handler function.
tool("get-messaging-service", "Get messaging service by name", getMessagingServiceSchema.shape, wrapToolHandler(getMessagingService)); - src/index.ts:43-44 (registration)The import statement that brings in 'getMessagingServiceSchema' and 'getMessagingService' from the services module into the main index.ts file.
listMessagingServicesSchema, listMessagingServices, getMessagingServiceSchema, getMessagingService, listPipelineServicesSchema, listPipelineServices, getPipelineServiceSchema, getPipelineService,