Skip to main content
Glama

update_project

Modify GitHub project details including title, description, visibility, and status to keep project information current and aligned with development progress.

Instructions

Update an existing GitHub project

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectIdYes
titleNo
descriptionNo
visibilityNo
statusNo

Implementation Reference

  • Core handler function that executes the update_project tool logic. Validates input, maps to domain model, and calls the GitHub project repository to perform the update.
    async updateProject(data: {
      projectId: string;
      title?: string;
      description?: string;
      visibility?: 'private' | 'public';
      status?: 'active' | 'closed';
    }): Promise<Project> {
      try {
        // Convert the status string to ResourceStatus enum
        let resourceStatus: ResourceStatus | undefined;
        if (data.status) {
          resourceStatus = data.status === 'active' ? ResourceStatus.ACTIVE : ResourceStatus.CLOSED;
        }
    
        // Map the data to the domain model
        const projectData: Partial<Project> = {
          title: data.title,
          description: data.description,
          visibility: data.visibility,
          status: resourceStatus,
        };
    
        // Clean up undefined values
        Object.keys(projectData).forEach((key) => {
          if (projectData[key as keyof Partial<Project>] === undefined) {
            delete projectData[key as keyof Partial<Project>];
          }
        });
    
        return await this.projectRepo.update(data.projectId, projectData);
      } catch (error) {
        throw this.mapErrorToMCPError(error);
      }
    }
  • Tool definition including Zod input schema (updateProjectSchema), description, and usage examples for the update_project tool.
    export const updateProjectTool: ToolDefinition<UpdateProjectArgs> = {
      name: "update_project",
      description: "Update an existing GitHub project",
      schema: updateProjectSchema as unknown as ToolSchema<UpdateProjectArgs>,
      examples: [
        {
          name: "Update project title and visibility",
          description: "Change a project's title and make it public",
          args: {
            projectId: "PVT_kwDOLhQ7gc4AOEbH",
            title: "Updated API Development",
            visibility: "public"
          }
        },
        {
          name: "Close a project",
          description: "Mark a project as closed",
          args: {
            projectId: "PVT_kwDOLhQ7gc4AOEbH",
            status: "closed"
          }
        }
      ]
    };
  • Registers the updateProjectTool in the central ToolRegistry, making it available for MCP list_tools requests.
    // Register project tools
    this.registerTool(createProjectTool);
    this.registerTool(listProjectsTool);
    this.registerTool(getProjectTool);
    this.registerTool(updateProjectTool);
    this.registerTool(deleteProjectTool);
  • MCP server dispatcher that handles call_tool requests for update_project and delegates to ProjectManagementService.
    case "update_project":
      return await this.service.updateProject(args);
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It states 'update' which implies a mutation, but doesn't specify permissions required, whether changes are reversible, rate limits, or what happens to unspecified fields. This leaves significant gaps for a tool with mutation behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence with no wasted words. It's front-loaded with the core action and resource, making it easy to scan and understand quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity of a mutation tool with 5 parameters, 0% schema coverage, no annotations, and no output schema, the description is inadequate. It doesn't cover parameter meanings, behavioral traits, or usage context, leaving the agent with insufficient information to use the tool effectively.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema description coverage is 0%, so the description must compensate for all parameters. It mentions no parameters at all, failing to explain what fields can be updated (e.g., title, description, visibility, status) or their meanings. This leaves the 5 parameters undocumented beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'update' and the resource 'existing GitHub project', making the purpose unambiguous. However, it doesn't differentiate from sibling tools like 'update_issue' or 'update_milestone' beyond the resource type, which keeps it from a perfect score.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives like 'create_project' or other update tools. It lacks any mention of prerequisites, such as needing an existing project ID, or context for when updates are appropriate.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/HarshKumarSharma/MCP'

If you have feedback or need assistance with the MCP directory API, please join our Discord server