import { z } from 'zod';
import { ContentType } from '../clients/postman.js';
import { asMcpError, McpError } from './utils/toolHelpers.js';
export const method = 'createEnvironment';
export const description = 'Creates an environment.\n\n**Note:**\n\n- The request body size cannot exceed the maximum allowed size of 30MB.\n- If you receive an HTTP \\`411 Length Required\\` error response, manually pass the \\`Content-Length\\` header and its value in the request header.\n- If you do not include the \\`workspace\\` query parameter, the system creates the environment in the oldest personal Internal workspace you own.\n';
export const parameters = z.object({
workspace: z.string().describe("The workspace's ID."),
environment: z
.object({
name: z.string().describe("The environment's name."),
values: z
.array(z
.object({
enabled: z.boolean().describe('If true, the variable is enabled.').optional(),
key: z.string().describe("The variable's name.").optional(),
value: z.string().describe("The variable's value.").optional(),
type: z
.enum(['secret', 'default'])
.describe("The variable's type:\n- `secret` — The variable value is masked.\n- `default` — The variable value is visible in plain text.\n")
.optional(),
description: z.string().max(512).describe("The variable's description.").optional(),
})
.describe("Information about the environment's variables."))
.describe("Information about the environment's variables.")
.optional(),
})
.describe('Information about the environment.')
.optional(),
});
export const annotations = {
title: 'Creates an environment.\n\n**Note:**\n\n- The request body size cannot exceed the maximum allowed size of 30MB.\n- If you receive an HTTP \\`411 Length Required\\` error response, manually pass the \\`Content-Length\\` header and its value in the request header.\n- If you do not include the \\`workspace\\` query parameter, the system creates the environment in the oldest personal Internal workspace you own.\n',
readOnlyHint: false,
destructiveHint: false,
idempotentHint: false,
};
export async function handler(args, extra) {
try {
const endpoint = `/environments`;
const query = new URLSearchParams();
if (args.workspace !== undefined)
query.set('workspace', String(args.workspace));
const url = query.toString() ? `${endpoint}?${query.toString()}` : endpoint;
const bodyPayload = {};
if (args.environment !== undefined)
bodyPayload.environment = args.environment;
const options = {
body: JSON.stringify(bodyPayload),
contentType: ContentType.Json,
headers: extra.headers,
};
const result = await extra.client.post(url, options);
return {
content: [
{
type: 'text',
text: `${typeof result === 'string' ? result : JSON.stringify(result, null, 2)}`,
},
],
};
}
catch (e) {
if (e instanceof McpError) {
throw e;
}
throw asMcpError(e);
}
}
