Skip to main content
Glama
kunwarVivek

mcp-github-project-manager

get_automation_rule

Retrieve details of a specific automation rule to manage GitHub project workflows, enabling users to view rule configurations and settings for automated task management.

Instructions

Get details of a specific automation rule

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ruleIdYes

Implementation Reference

  • Primary handler implementation in ProjectManagementService that retrieves a specific automation rule by ID from the automation repository, formats the response, and handles errors.
    async getAutomationRule(data: { ruleId: string }): Promise<{
      id: string;
      name: string;
      description?: string;
      projectId: string;
      enabled: boolean;
      triggers: any[];
      actions: any[];
      createdAt: string;
      updatedAt?: string;
    }> {
      try {
        const rule = await this.automationRepo.findById(data.ruleId);
        if (!rule) {
          throw new ResourceNotFoundError(ResourceType.RELATIONSHIP, data.ruleId);
        }
    
        return {
          id: rule.id,
          name: rule.name,
          description: rule.description,
          projectId: rule.projectId,
          enabled: rule.enabled,
          triggers: rule.triggers,
          actions: rule.actions,
          createdAt: rule.createdAt.toISOString(),
          updatedAt: rule.updatedAt?.toISOString()
        };
      } catch (error) {
        throw this.mapErrorToMCPError(error);
      }
    }
  • Tool definition including schema (zod validation), description, and usage examples for get_automation_rule. Schema requires 'ruleId' string.
    export const getAutomationRuleTool: ToolDefinition<GetAutomationRuleArgs> = {
      name: "get_automation_rule",
      description: "Get details of a specific automation rule",
      schema: getAutomationRuleSchema as unknown as ToolSchema<GetAutomationRuleArgs>,
      examples: [
        {
          name: "Get rule details",
          description: "Retrieve details of an automation rule",
          args: {
            ruleId: "AR_kwDOLhQ7gc4AOEbH"
          }
        }
      ]
    };
  • Registration of the getAutomationRuleTool in the central ToolRegistry singleton.
    this.registerTool(getAutomationRuleTool);
  • MCP server dispatcher that routes 'get_automation_rule' tool calls to the ProjectManagementService handler.
    case "get_automation_rule":
      return await this.service.getAutomationRule(args);
  • Getter for the AutomationRuleRepository used by the handler to persist/retrieve rules.
      return this.factory.createAutomationRuleRepository();
    }
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 what the tool does without behavioral details. It doesn't disclose whether this is a read-only operation, what permissions are required, error handling, or response format, leaving significant gaps for a tool that likely accesses sensitive automation data.

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 gets straight to the point with no wasted words. It's appropriately sized for a simple retrieval tool and front-loads the essential information.

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?

For a tool with no annotations, 0% schema coverage, and no output schema, the description is insufficient. It doesn't explain what 'details' include, how to handle errors, or provide context about automation rules in this system, making it inadequate for safe and effective use by an AI agent.

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?

Schema description coverage is 0% with one required parameter 'ruleId'. The description mentions 'a specific automation rule' which implies the parameter identifies the rule, but doesn't explain what a ruleId is, its format, or where to obtain it, failing to compensate for the schema's lack of documentation.

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 details') and resource ('of a specific automation rule'), making the purpose understandable. It distinguishes from sibling 'list_automation_rules' by specifying retrieval of a single rule rather than listing multiple, though this distinction could be more 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 like 'list_automation_rules' or 'get_issue' for related data. The description implies usage when details of a specific rule are needed, but lacks explicit context or prerequisites.

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/kunwarVivek/mcp-github-project-manager'

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