Skip to main content
Glama

get_project

Retrieve detailed information about a specific GitHub project by providing the repository owner, repository name, and project number to streamline project management and tracking.

Instructions

Get details about a specific project

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ownerYesRepository owner (username or organization)
project_numberYesThe project number
repoYesRepository name

Implementation Reference

  • Core handler function that retrieves a specific GitHub project by owner, repo, and project number by listing all projects in the repo and filtering.
    export async function getProject(owner: string, repo: string, projectNumber: number) {
        try {
            const url = `https://api.github.com/repos/${owner}/${repo}/projects`;
    
            const projects = await githubRequest(url) as any[];
    
            // Tìm project theo number
            const project = projects.find((p: any) => p.number === projectNumber);
    
            if (!project) {
                throw new GitHubError(`Project with number ${projectNumber} not found`, 404, { message: `Project ${projectNumber} not found` });
            }
    
            return project;
        } catch (error) {
            if (error instanceof GitHubError) {
                throw error;
            }
    
            throw new GitHubError(`Failed to get project: ${(error as Error).message}`, 500, { error: (error as Error).message });
        }
    }
  • Zod schema defining the input parameters for the get_project tool.
    export const GetProjectSchema = z.object({
        owner: z.string().describe("Repository owner (username or organization)"),
        repo: z.string().describe("Repository name"),
        project_number: z.number().describe("The project number"),
    });
  • index.ts:206-208 (registration)
    Tool registration in the MCP server's list of tools, specifying name, description, and input schema.
    name: "get_project",
    description: "Get details about a specific project",
    inputSchema: zodToJsonSchema(projects.GetProjectSchema),
  • MCP request handler case that parses arguments, calls the getProject function, and formats the response.
    case "get_project": {
      const args = projects.GetProjectSchema.parse(request.params.arguments);
      const result = await projects.getProject(
        args.owner,
        args.repo,
        args.project_number
      );
      return {
        content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
      };
    }
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. It states 'Get details' which implies a read-only operation, but it doesn't disclose behavioral traits like authentication requirements, rate limits, error handling, or what 'details' includes (e.g., fields returned, format). For a tool with no annotations, this leaves significant gaps in understanding its 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: 'Get details about a specific project'. It's front-loaded with the core action and resource, with zero wasted words. Every part earns its place by conveying the essential purpose without redundancy.

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 (3 required parameters, no annotations, no output schema, and many sibling tools), the description is incomplete. It doesn't address key contextual aspects like what 'details' includes, how it differs from 'get_project_v2', or prerequisites (e.g., repository access). For a read operation in a crowded toolset, more guidance is needed to ensure correct usage.

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 schema description coverage is 100%, with clear descriptions for 'owner', 'repo', and 'project_number'. The description adds no meaning beyond the schema—it doesn't explain parameter relationships (e.g., that 'owner' and 'repo' identify the repository containing the project) or provide context like valid formats. With high schema coverage, the baseline is 3, and the description doesn't compensate with extra insights.

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

Purpose3/5

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

The description 'Get details about a specific project' clearly states the verb ('Get') and resource ('project'), but it's vague about what 'details' entails and doesn't differentiate from sibling tools like 'get_project_v2', 'list_projects', or 'list_organization_projects'. It specifies 'specific project' which implies it retrieves a single item, but this distinction isn't explicit.

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?

No guidance is provided on when to use this tool versus alternatives. With siblings like 'get_project_v2', 'list_projects', and 'list_organization_projects', the description doesn't clarify if this is for GitHub Projects v1 vs. v2, single vs. multiple projects, or organization vs. repository contexts. The agent must infer usage from the parameter schema 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

Related 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/tuanle96/mcp-github'

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