Skip to main content
Glama

list-projects

Retrieve all projects in your Plane workspace to view and manage project details for improved organization and workflow oversight.

Instructions

List all projects in the workspace

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Handler for the list-projects tool: calls Plane API to GET /projects/ and returns formatted JSON response.
    case "list-projects": {
      const projects = await callPlaneAPI("/projects/", "GET");
      return {
        content: [{ type: "text", text: JSON.stringify(projects, null, 2) }],
        isError: false,
      };
    }
  • Tool schema definition for list-projects: name, description, and empty input schema (no parameters required).
    const LIST_PROJECTS_TOOL: Tool = {
      name: "list-projects",
      description: "List all projects in the workspace",
      inputSchema: {
        type: "object",
        properties: {},
        required: [],
      },
    };
  • src/index.ts:262-271 (registration)
    Registration of the list-projects tool in the ListToolsRequestHandler, exposing it in the tools list.
    server.setRequestHandler(ListToolsRequestSchema, async () => ({
      tools: [
        LIST_PROJECTS_TOOL,
        GET_PROJECT_TOOL,
        CREATE_ISSUE_TOOL,
        LIST_ISSUES_TOOL,
        GET_ISSUE_TOOL,
        UPDATE_ISSUE_TOOL,
      ],
    }));
  • Shared helper function callPlaneAPI used by list-projects handler to make authenticated API calls to Plane.
    async function callPlaneAPI(
      endpoint: string,
      method: string,
      body?: any
    ): Promise<any> {
      const baseUrl = `${PLANE_HOST}/api/v1/workspaces/${PLANE_WORKSPACE_SLUG}`;
      const url = `${baseUrl}${endpoint}`;
    
      const options: RequestInit = {
        method,
        headers: {
          "Content-Type": "application/json",
          "X-API-Key": PLANE_API_KEY as string,
        },
      };
    
      if (body && (method === "POST" || method === "PATCH")) {
        options.body = JSON.stringify(body);
      }
    
      try {
        const response = await fetch(url, options);
    
        if (!response.ok) {
          let errorText;
          try {
            errorText = await response.text();
          } catch (parseError) {
            errorText = "Unable to parse error response";
          }
          throw new Error(
            `Plane API error: ${response.status} ${response.statusText}\n${errorText}`
          );
        }
    
        // For DELETE requests that return 204 No Content
        if (response.status === 204) {
          return { success: true };
        }
    
        return await response.json();
      } catch (error) {
        throw new Error(
          `Error calling Plane API: ${
            error instanceof Error ? error.message : String(error)
          }`
        );
      }
    }
Behavior2/5

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

With no annotations provided, the description carries full burden but only states the basic action. It doesn't disclose behavioral traits like pagination, sorting, filtering capabilities, rate limits, authentication requirements, or what data is returned. 'List all projects' implies a read operation but lacks operational details.

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 directly states the tool's function without any wasted words. It's appropriately sized for a simple list operation and front-loaded with the essential information.

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

Completeness3/5

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

For a simple list tool with no parameters and no output schema, the description is minimally adequate but lacks important context. It doesn't explain what information is returned about projects, whether there are limitations on the listing, or how results are structured, leaving gaps for the agent to understand the tool's behavior.

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

Parameters4/5

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

The tool has 0 parameters with 100% schema description coverage, so no parameter documentation is needed. The description appropriately doesn't discuss parameters, maintaining focus on the tool's purpose without unnecessary detail.

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 ('List') and resource ('projects'), specifying scope ('all projects in the workspace'). It distinguishes from sibling 'get-project' which retrieves a single project, but doesn't explicitly differentiate from other list operations like 'list-issues'.

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. The description doesn't mention prerequisites, when this should be preferred over other tools, or any contextual constraints for usage.

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/kelvin6365/plane-mcp-server'

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