@heroku/mcp-server
Version:
Heroku Platform MCP Server
33 lines (32 loc) • 1.66 kB
JavaScript
import { z } from 'zod';
import { handleCliOutput } from '../utils/handle-cli-output.js';
import { CommandBuilder } from '../utils/command-builder.js';
import { TOOL_COMMAND_MAP } from '../utils/tool-commands.js';
/**
* Schema for listing Heroku Teams with output format options.
* This schema defines the structure and validation rules for the list teams operation.
*
* [json] - Controls the output format. When true, returns a detailed JSON response containing
* team metadata such as enterprise account name. When false or omitted, returns a simplified text format.
*/
export const listTeamsOptionsSchema = z.object({
json: z
.boolean()
.optional()
.describe('Output format control - true for detailed JSON with team metadata, false/omitted for simplified text')
});
/**
* Registers the list_teams tool with the MCP server.
* This tool provides information about accessible Heroku Teams,
* including membership details and enterprise relationships.
*
* @param server - The MCP server instance to register the tool with
* @param herokuRepl - The Heroku REPL instance for executing commands
*/
export const registerListTeamsTool = (server, herokuRepl) => {
server.tool('list_teams', 'Lists accessible Heroku Teams. Use for: viewing teams, checking membership, getting team metadata, and verifying access. JSON output available.', listTeamsOptionsSchema.shape, async (options) => {
const command = new CommandBuilder(TOOL_COMMAND_MAP.LIST_TEAMS).addFlags({ json: options.json }).build();
const output = await herokuRepl.executeCommand(command);
return handleCliOutput(output);
});
};