Skip to main content
Glama

pylon_get_issue

Get issue details by ID or number, returning standard fields. Optionally include a truncated body preview of the issue content.

Instructions

Get issue details by ID or number. Returns standard fields (no body). Use pylon_get_issue_body to fetch body content.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe issue ID or issue number
include_bodyNoInclude truncated body preview (500 chars max)

Implementation Reference

  • The main tool handler for 'pylon_get_issue'. Calls client.getIssue(id), then transforms the raw response using toIssueStandard (default) or toIssueFull (if include_body is true). Returns JSON-formatted issue details.
    server.tool(
    	'pylon_get_issue',
    	'Get issue details by ID or number. Returns standard fields (no body). Use pylon_get_issue_body to fetch body content.',
    	{
    		id: z.string().describe('The issue ID or issue number'),
    		include_body: z
    			.boolean()
    			.optional()
    			.describe('Include truncated body preview (500 chars max)'),
    	},
    	async ({ id, include_body }) => {
    		const result = await client.getIssue(id);
    		const raw = result.data as unknown as Record<string, unknown>;
    
    		if (include_body) {
    			const issue = toIssueFull(raw);
    			return {
    				content: [{ type: 'text', text: JSON.stringify(issue, null, 2) }],
    			};
    		}
    
    		const issue = toIssueStandard(raw);
    		return {
    			content: [{ type: 'text', text: JSON.stringify(issue, null, 2) }],
    		};
    	},
  • IssueStandardSchema used for default pylon_get_issue output - extends IssueMinimalSchema with requester_id, team_id, resolution_time, etc. IssueFullSchema adds body_html.
    export const IssueStandardSchema = IssueMinimalSchema.extend({
    	requester_id: z.string().nullable().optional(),
    	team_id: z.string().nullable().optional(),
    	resolution_time: z.string().nullable().optional(),
    	latest_message_time: z.string().nullable().optional(),
    	first_response_time: z.string().nullable().optional(),
    	customer_portal_visible: z.boolean().optional(),
    	source: z.string().optional(),
    	type: z.string().optional(),
    });
    
    /**
     * Full issue including body - only used when explicitly requested.
     * The body_html is truncated to prevent context overflow.
     */
    export const IssueFullSchema = IssueStandardSchema.extend({
    	body_html: z.string().nullable().optional(),
    });
  • toIssueStandard() - transforms raw API response to IssueStandard format (no body). Called by the handler when include_body is false.
    export function toIssueStandard(raw: Record<string, unknown>): IssueStandard {
    	return {
    		...toIssueMinimal(raw),
    		requester_id: extractRequesterId(raw),
    		team_id: extractTeamId(raw),
    		resolution_time: raw['resolution_time'] as string | null | undefined,
    		latest_message_time: raw['latest_message_time'] as string | null | undefined,
    		first_response_time: raw['first_response_time'] as string | null | undefined,
    		customer_portal_visible: raw['customer_portal_visible'] as boolean | undefined,
    		source: raw['source'] as string | undefined,
    		type: raw['type'] as string | undefined,
    	};
    }
  • toIssueFull() - transforms raw API response to IssueFull format with truncated body_html (500 chars). Called by the handler when include_body is true.
    export function toIssueFull(raw: Record<string, unknown>): IssueFull {
    	return {
    		...toIssueStandard(raw),
    		body_html: stripHtmlAndTruncate(
    			raw['body_html'] as string | null | undefined,
    			MAX_BODY_LENGTH,
    		),
    	};
    }
  • src/index.ts:614-640 (registration)
    Registration of the 'pylon_get_issue' tool via server.tool() with name, description, zod schema params (id: string, include_body: optional boolean), and handler function.
    server.tool(
    	'pylon_get_issue',
    	'Get issue details by ID or number. Returns standard fields (no body). Use pylon_get_issue_body to fetch body content.',
    	{
    		id: z.string().describe('The issue ID or issue number'),
    		include_body: z
    			.boolean()
    			.optional()
    			.describe('Include truncated body preview (500 chars max)'),
    	},
    	async ({ id, include_body }) => {
    		const result = await client.getIssue(id);
    		const raw = result.data as unknown as Record<string, unknown>;
    
    		if (include_body) {
    			const issue = toIssueFull(raw);
    			return {
    				content: [{ type: 'text', text: JSON.stringify(issue, null, 2) }],
    			};
    		}
    
    		const issue = toIssueStandard(raw);
    		return {
    			content: [{ type: 'text', text: JSON.stringify(issue, null, 2) }],
    		};
    	},
    );
Behavior3/5

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

With no annotations, the description must carry the full burden. It discloses that the tool returns standard fields without body content, implying read-only behavior. However, it lacks details on idempotency, error handling, permissions, or response format. It is adequate but not comprehensive.

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?

Two concise sentences front-load the purpose and immediately redirect to a sibling where appropriate. Every word earns its place; there is no redundancy or fluff.

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?

Given no output schema, the description should explain what 'standard fields' are or outline the response structure. It does not. It adequately covers the scope and relationship to a sibling, but leaves gaps in expected output and error scenarios.

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 coverage is 100%, but the description adds minimal value beyond the schema and contains a contradiction. The description states 'no body' while the 'include_body' parameter allows a truncated body preview. This inconsistency undermines clarity and fails to resolve ambiguity.

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

Purpose5/5

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

The description clearly states the tool retrieves issue details by ID or number, explicitly distinguishes from the sibling 'pylon_get_issue_body' by noting it returns no body, and directs to that sibling for body content. This makes the purpose unambiguous and distinct.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear usage context by stating when to use this tool (to get issue details) and when to use the alternative (pylon_get_issue_body for body content). It does not explicitly state when not to use it or other exclusions, but the guidance is sufficient for basic decision-making.

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/JustinBeckwith/pylon-mcp'

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