Skip to main content
Glama

get_project

Retrieve detailed information about a specific GitHub project by providing its project ID, enabling users to access project data for management and analysis.

Instructions

Get details of a specific GitHub project

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectIdYes

Implementation Reference

  • Core handler: Executes GraphQL query to fetch GitHub ProjectV2 by ID and maps response to domain Project model.
    async findById(id: ProjectId): Promise<Project | null> {
      const query = `
        query($id: ID!) {
          node(id: $id) {
            ... on ProjectV2 {
              id
              title
              shortDescription
              closed
              createdAt
              updatedAt
            }
          }
        }
      `;
    
      const response = await this.graphql<GetProjectResponse>(query, { id });
      if (!response.node) return null;
    
      const project = response.node;
      return {
        id: project.id,
        type: ResourceType.PROJECT,
        title: project.title,
        description: project.shortDescription || "",
        owner: this.owner,
        number: parseInt(project.id.split('_').pop() || '0'),
        url: `https://github.com/orgs/${this.owner}/projects/${parseInt(project.id.split('_').pop() || '0')}`,
        status: project.closed ? ResourceStatus.CLOSED : ResourceStatus.ACTIVE,
        visibility: "private",
        views: [],
        fields: [],
        createdAt: project.createdAt,
        updatedAt: project.updatedAt,
        closed: project.closed
      };
    }
  • Service layer handler: Delegates get_project tool execution to GitHubProjectRepository.findById.
    async getProject(projectId: string): Promise<Project | null> {
      try {
        return await this.projectRepo.findById(projectId);
      } catch (error) {
        throw this.mapErrorToMCPError(error);
      }
    }
  • MCP dispatcher: Routes 'get_project' tool calls to ProjectManagementService.getProject.
    case "get_project":
      return await this.service.getProject(args.projectId);
  • Input schema validation: Defines projectId as required string.
    export const getProjectSchema = z.object({
      projectId: z.string().min(1, "Project ID is required"),
    });
    
    export type GetProjectArgs = z.infer<typeof getProjectSchema>;
  • Tool registration: Registers getProjectTool in the central registry for MCP list_tools.
    this.registerTool(getProjectTool);
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states it 'gets details' but doesn't clarify if this is a read-only operation, what permissions are required, whether it's idempotent, or how errors are handled (e.g., invalid project IDs). For a tool with zero annotation coverage, this leaves critical behavioral traits unspecified.

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, front-loaded sentence with zero wasted words—it directly states the tool's function. Every word ('Get details of a specific GitHub project') earns its place by clarifying scope and resource, making it highly efficient and well-structured.

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 tool's low complexity (1 parameter, no nested objects) but lack of annotations and output schema, the description is incomplete. It doesn't explain what 'details' include in the return value, error conditions, or dependencies on other tools (e.g., 'projectId' from 'list_projects'). For a read operation with no structured output documentation, more context is needed to guide effective use.

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

Parameters3/5

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

The input schema has 1 parameter ('projectId') with 0% description coverage, so the schema provides no semantic context. The description implies the parameter identifies 'a specific GitHub project' but doesn't specify format (e.g., numeric ID, URL) or sourcing (e.g., from 'list_projects'). This adds minimal meaning beyond the schema's structural definition, aligning with the baseline for low coverage.

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 ('Get') and resource ('details of a specific GitHub project'), making the purpose unambiguous. It distinguishes from siblings like 'list_projects' (which returns multiple projects) by specifying retrieval of a single project's details. However, it doesn't specify what 'details' include (e.g., fields, metadata), which prevents 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. It doesn't mention prerequisites (e.g., needing a project ID), contrast with 'list_projects' for browsing, or specify scenarios like retrieving metadata for editing. Without such context, the agent must infer usage from the name alone.

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