get_project
Retrieve detailed information about a specific Yunxiao DevOps project by providing its organization ID and project identifier.
Instructions
[Project Management] Get information about a Yunxiao project
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| organizationId | Yes | Organization ID | |
| id | Yes | Project unique identifier |
Implementation Reference
- The main handler for the 'get_project' tool. Parses input arguments using GetProjectSchema, calls the underlying getProjectFunc helper to fetch project details via API, and returns the JSON-formatted project information.
case "get_project": { const args = types.GetProjectSchema.parse(request.params.arguments); const projectInfo = await project.getProjectFunc( args.organizationId, args.id ); return { content: [{ type: "text", text: JSON.stringify(projectInfo, null, 2) }], }; } - operations/projex/types.ts:235-238 (schema)Zod schema definition for 'get_project' tool input validation: requires organizationId and project id.
export const GetProjectSchema = z.object({ organizationId: z.string().describe("Organization ID"), id: z.string().describe("Project unique identifier"), }); - tool-registry/project-management.ts:8-11 (registration)Tool registration object defining name, description, and input schema for 'get_project' within the getProjectManagementTools array, which is included in the PROJECT_MANAGEMENT toolset.
name: "get_project", description: "[Project Management] Get information about a Yunxiao project", inputSchema: zodToJsonSchema(types.GetProjectSchema), }, - operations/projex/project.ts:23-34 (helper)Core helper function that performs the actual API call to retrieve project information using Yunxiao's projex API and validates the response with ProjectInfoSchema.
export async function getProjectFunc( organizationId: string, id: string ): Promise<z.infer<typeof ProjectInfoSchema>> { const url = `/oapi/v1/projex/organizations/${organizationId}/projects/${id}`; const response = await yunxiaoRequest(url, { method: "GET", }); return ProjectInfoSchema.parse(response); }