Skip to main content
Glama
ratheesh-aot

Clockify MCP Server

by ratheesh-aot

get_project

Retrieve a specific project's details from Clockify using its workspace and project IDs to access time tracking data and manage project organization.

Instructions

Get a specific project by ID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workspaceIdYesWorkspace ID
projectIdYesProject ID

Implementation Reference

  • The main handler function that retrieves a specific project by its ID from the Clockify API endpoint `/workspaces/{workspaceId}/projects/{projectId}` and formats the response as MCP content.
    private async getProject(workspaceId: string, projectId: string) {
      const project = await this.makeRequest(`/workspaces/${workspaceId}/projects/${projectId}`);
    
      return {
        content: [
          {
            type: "text",
            text: `Project Details:\nName: ${project.name}\nID: ${project.id}\nClient: ${project.clientName || "No client"}\nPublic: ${project.public}\nBillable: ${project.billable}\nColor: ${project.color}\nArchived: ${project.archived}`,
          },
        ],
        isError: false,
      };
    }
  • src/index.ts:757-759 (registration)
    Registration of the 'get_project' tool in the CallToolRequestSchema handler switch statement, which validates parameters and delegates to the getProject method.
    case "get_project":
      if (!args?.workspaceId || !args?.projectId) throw new McpError(ErrorCode.InvalidParams, 'workspaceId and projectId are required');
      return await this.getProject(args.workspaceId as string, args.projectId as string);
  • Tool schema definition and registration in the ListToolsRequestSchema response, including name, description, and input schema for the 'get_project' tool.
      name: "get_project",
      description: "Get a specific project by ID",
      inputSchema: {
        type: "object",
        properties: {
          workspaceId: { type: "string", description: "Workspace ID" },
          projectId: { type: "string", description: "Project ID" },
        },
        required: ["workspaceId", "projectId"],
      },
    },
  • TypeScript interface defining the structure of a Project object, used in the tool's response handling.
    interface Project {
      id?: string;
      name: string;
      clientId?: string;
      workspaceId: string;
      isPublic?: boolean;
      billable?: boolean;
      color?: string;
      estimate?: {
        estimate: string;
        type: "AUTO" | "MANUAL";
      };
    }
Behavior2/5

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

No annotations are provided, so the description carries full burden. 'Get' implies a read-only operation, but it doesn't disclose behavioral traits such as error handling (e.g., what happens if IDs are invalid), response format, or whether it requires specific permissions. The description is minimal and lacks necessary context for safe invocation.

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 that front-loads the core purpose without unnecessary words. Every part of the sentence ('Get a specific project by ID') contributes directly to understanding the tool's function, making it highly concise 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 no annotations and no output schema, the description is incomplete for a tool with 2 required parameters. It doesn't explain what 'get' returns (e.g., project details, status), error conditions, or authentication needs. For a read operation in a system with multiple similar tools, more context 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?

Schema description coverage is 100%, with both parameters clearly documented in the schema. The description adds no additional meaning beyond implying 'projectId' identifies the specific project and 'workspaceId' provides context. It doesn't explain parameter relationships or format expectations, so baseline 3 is appropriate.

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 action ('Get') and resource ('a specific project by ID'), making the purpose immediately understandable. It distinguishes from sibling tools like 'get_projects' (plural) by specifying retrieval of a single project. However, it doesn't explicitly mention what 'get' entails (e.g., retrieving metadata/details).

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 when to choose 'get_project' over 'get_projects' or other retrieval tools, nor does it specify prerequisites like authentication or workspace context needed before use.

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/ratheesh-aot/clockify-mcp'

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