Skip to main content
Glama

zendesk_post_internal_note

Post an internal note on a Zendesk ticket to communicate with agents without notifying the requester.

Instructions

Post an internal note on a Zendesk ticket. Internal notes are only visible to agents and are not sent to the requester.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ticket_idYes
bodyYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The tool handler for zendesk_post_internal_note. Calls _post_comment_data with public=False to post an internal (agent-only) note on a Zendesk ticket.
    @mcp.tool()
    def zendesk_post_internal_note(ticket_id: int, body: str) -> str:
        """Post an internal note on a Zendesk ticket. Internal notes are only visible to agents and are not sent to the requester."""
        return _post_comment_data(ticket_id, body, public=False)
  • Shared helper _post_comment_data that handles the actual Zendesk API call via Zenpy client. Creates a Ticket with a Comment (public or internal) and updates it.
    def _post_comment_data(ticket_id: int, body: str, public: bool) -> str:
        try:
            client = get_client()
            ticket = Ticket(id=ticket_id)
            ticket.comment = Comment(body=body, public=public)
            client.tickets.update(ticket)
            label = "Public comment" if public else "Internal note"
            return f"{label} posted successfully on ticket #{ticket_id}."
        except ConfigError as e:
            return str(e)
        except Exception as e:
            if "RecordNotFound" in str(e) or "404" in str(e):
                return f"Ticket #{ticket_id} not found or not accessible with current credentials."
            return f"Zendesk API error: {e}"
  • Registration call that registers all write_comment tools (including zendesk_post_internal_note) via register_write_comment_tools(mcp).
    register_write_comment_tools(mcp)
    register_update_ticket_tools(mcp)
    register_time_tracking_tools(mcp)
    register_git_zen_tools(mcp)
    
    mcp.run()
  • Registration function that decorates both zendesk_post_comment and zendesk_post_internal_note with @mcp.tool() on the FastMCP instance.
    def register_write_comment_tools(mcp) -> None:
        @mcp.tool()
        def zendesk_post_comment(ticket_id: int, body: str) -> str:
            """Post a public reply on a Zendesk ticket. The reply is visible to the requester. Use for customer-facing responses."""
            return _post_comment_data(ticket_id, body, public=True)
    
        @mcp.tool()
        def zendesk_post_internal_note(ticket_id: int, body: str) -> str:
  • The get_client() helper used by _post_comment_data to obtain a Zenpy client configured with subdomain and OAuth token.
    def get_client(config_file: Path | None = None) -> Zenpy:
        cfg = load_config(config_file)
        subdomain = cfg.get("subdomain", "").strip()
        token = cfg.get("oauth_token", "").strip()
        if not subdomain or not token:
            raise ConfigError("Zendesk not configured. Run: zendesk-mcp setup")
        return Zenpy(subdomain=subdomain, oauth_token=token)
Behavior3/5

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

No annotations are provided, so the description must bear the burden of behavioral disclosure. It correctly notes the visibility and audience of the note, but lacks details on prerequisites, error handling, or authentication requirements.

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, clear sentence with no unnecessary words, making it highly concise and easy to parse.

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

Completeness4/5

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

Given the tool's simplicity (two parameters, no nested objects, output schema exists), the description sufficiently covers its purpose and behavior. However, it could briefly mention prerequisites like ensuring the ticket exists or handling errors.

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% and the description adds no additional meaning to the parameters 'ticket_id' and 'body' beyond their types. For example, it does not specify format or constraints for ticket_id or body content.

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 action ('Post'), the resource ('internal note on a Zendesk ticket'), and distinguishes it from the sibling tool 'zendesk_post_comment' (likely for public comments).

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 explains that internal notes are visible only to agents and not sent to the requester, implicitly guiding when to use this versus a public comment. An explicit mention of the alternative sibling would improve clarity.

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/michaelrice/zendesk-mcp'

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