Skip to main content
Glama
roddyst

i-net HelpDesk MCP Server

by roddyst

i-net HelpDesk MCP 服务器

一个 MCP 服务器,将 i-net HelpDesk 的工单 Web API 作为工具提供给任意 AI 代理使用:搜索和读取工单、查看处理步骤、创建新工单以及执行工单操作(回复、关闭、升级等)——包括文件附件。

该服务器可通过两种方式运行:

模式

用途

身份验证

stdio

每个代理的本地进程(Claude Desktop/Code、Cursor、VS Code 等)

来自环境变量的令牌或用户名/密码

HTTP(可流式传输)

集中托管,多个用户共享一个服务器进程

每个客户端发送自己的 Authorization 标头,可选地附加 HelpDesk URL


前提条件

  • Python 3.10 或更高版本

  • 一个启用了 Web API 的 i-net HelpDesk

  • 一个拥有 “Web API” 权限的用户——没有此权限,服务器将返回 HTTP 403。哪些工单可见以及允许哪些操作,取决于该用户的角色。

Related MCP server: tickiti-mcp

安装

# direkt aus dem Repository ausführen (empfohlen für den Einstieg)
uvx --from git+https://github.com/roddyst/i-net_mcp_server inet-helpdesk-mcp --help

# oder klassisch installieren
pip install git+https://github.com/roddyst/i-net_mcp_server

用于开发:

git clone https://github.com/roddyst/i-net_mcp_server
cd i-net_mcp_server
python -m venv .venv && . .venv/bin/activate
pip install -e ".[dev]"
pytest

快速入门:stdio(本地代理)

export INET_BASE_URL="https://helpdesk.example.com:9000"
export INET_TOKEN="VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u"
inet-helpdesk-mcp

Claude Desktop / Claude Code 的配置(claude_desktop_config.json 或 .mcp.json)——更多示例位于 examples/:

{
  "mcpServers": {
    "i-net-helpdesk": {
      "command": "uvx",
      "args": ["--from", "git+https://github.com/roddyst/i-net_mcp_server", "inet-helpdesk-mcp"],
      "env": {
        "INET_BASE_URL": "https://helpdesk.example.com:9000",
        "INET_TOKEN": "dein-access-token"
      }
    }
  }
}

除了令牌,也可以使用 INET_USERNAME 和 INET_PASSWORD(基本身份验证)。令牌作为 Authorization: Bearer <token> 发送,与 i-net 文档中描述的方式完全相同。

快速入门:HTTP(集中托管)

inet-helpdesk-mcp --transport http --host 0.0.0.0 --port 8000 \
                  --base-url https://helpdesk.example.com:9000

端点位于 http://<host>:8000/mcp。代理输入此 URL 并在 Authorization 标头中发送其 HelpDesk 令牌——这正是“URL + Bearer 令牌”的流程,服务器将该标头转发给 HelpDesk。支持远程服务器的 MCP 客户端示例:

{
  "mcpServers": {
    "i-net-helpdesk": {
      "type": "http",
      "url": "https://mcp.example.com/mcp",
      "headers": { "Authorization": "Bearer dein-access-token" }
    }
  }
}

如果没有 --base-url,客户端还会通过 X-Inet-Base-Url 标头确定目标系统。这对于拥有多个 HelpDesk 实例的租户来说很方便,但会将服务器作为任意地址的代理打开——因此在开放网络中,最好设置一个固定的 --base-url(这样该标头将被禁用,除非使用 --allow-url-header 允许)。

运行提示: 服务器自身不终止 TLS 也不独立验证客户端——登录是通过传递的令牌在 HelpDesk 上完成的。如果它需要在本地网络之外可访问,则需要在前面放置一个带有 HTTPS 的反向代理。


工具

工具

Web API

描述

server_info

–

显示配置并检查连接和凭据。出现错误时的第一站。

search_tickets

POST /api/ticket/search

通过搜索短语查找工单(query、limit、start、locale)。

get_ticket

GET /api/ticket/<id>

工单的字段和属性;fields 限制响应。

list_ticket_actions

GET /api/ticket/<id>/actions

当前允许的工单操作,以“Id → 显示名称”映射形式返回。

list_ticket_steps

GET /api/ticket/<id>/steps

工单的处理步骤,可选地从时间戳 since 开始。

get_ticket_step

GET /api/ticket/<id>/steps/<step-id>

一个处理步骤,包括文本。

create_ticket

POST /api/ticket/create

创建新工单,返回工单 ID。

apply_ticket_action

POST /api/ticket/<id>/apply

执行工单操作,返回新处理步骤的 ID。

使用 --read-only 时,create_ticket 和 apply_ticket_action 根本不会被注册——当代理只需要读取权限时很有用。

工单 ID 可以以数字形式接受,也可以以 HelpDesk 电子邮件主题行中出现的编码形式接受。

典型流程

  1. 使用类似 Drucker 或 Resource:"First Level Support" 的短语调用 search_tickets

  2. 调用 get_ticket / list_ticket_steps / get_ticket_step 进行读取

  3. 调用 list_ticket_actions 以确定有效的 action_id

  4. 使用该 ID 调用 apply_ticket_action——ID 因工单、用户和工单状态而异,因此不能猜测。

工单字段和操作参数

ticket_fields、step_fields 和 action_arguments 是可选的,通常不需要。如果需要,则遵循 Web API 的规则:键必须对应真实的字段键(或其本地化的显示名称),值是字符串;JSON 值必须编码为字符串。来自 i-net 文档的示例:

{
  "ticketextension.dispatchNow": "ALWAYS",           // Ticket sofort disponieren
  "ticketextension.automail": "NO_MAILS_TO_ENDUSER", // keine Auto-Mails an Endanwender
  "processingtimeextension.appointment": "1733875200000", // Wiedervorlage/Termin
  "ticketactionextension.escalate": "{'targetResID':'<GUID>','changeTicketStatus':true}"
}

未知的 工单字段 会导致错误,未知的 操作参数 会被 HelpDesk 静默丢弃,仅写入调试日志。

附件

附件作为列表传递,每个附件的内容 要么 内联为 Base64 要么 作为服务器文件系统上的路径:

{
  "text": "Anfrage mit Anhang",
  "attachments": [
    { "name": "screenshot.png", "content_base64": "iVBORw0KGgo…" },
    { "path": "/tmp/protokoll.pdf", "attachment_type": "Attachment" }
  ]
}

path 仅在 stdio 模式下有效,在该模式下代理和服务器共享同一台机器;在 HTTP 模式下它会自动禁用(并且可以使用 --no-local-files 为 stdio 也禁用它)。attachment_type 的允许值:Attachment、EmbeddedImage、Signature、Unknown。每个文件的上限:25 MB。


配置

每个选项都可以作为环境变量和命令行开关使用;命令行优先级更高。

环境变量

开关

默认值

含义

INET_BASE_URL

--base-url

–

HelpDesk 的基础 URL,例如 https://helpdesk.example.com:9000

INET_TOKEN

--token

–

用于 Authorization: Bearer … 的访问令牌

INET_USERNAME / INET_PASSWORD

--username / --password

–

作为令牌替代方案的基本身份验证

INET_TRANSPORT

--transport

stdio

stdio、http 或 sse

INET_HOST

--host

127.0.0.1

HTTP 传输的绑定地址

INET_PORT

--port

8000

HTTP 传输的端口

INET_HTTP_PATH

--http-path

/mcp

可流式 HTTP 端点的路径

INET_TIMEOUT

--timeout

30

HTTP 超时(秒)

INET_VERIFY_TLS

--no-verify-tls

true

验证 HelpDesk 的 TLS 证书

INET_READ_ONLY

--read-only

false

隐藏写入工具

INET_ALLOW_URL_HEADER

--allow-url-header

仅当没有 INET_BASE_URL 时

允许 X-Inet-Base-Url 标头

INET_ALLOW_LOCAL_FILES

--no-local-files

stdio 为 true,否则为 false

允许通过文件路径添加附件

INET_LOCALE

--locale

en

搜索短语的默认语言


故障排除

  • 首先调用 server_info——它会显示基础 URL、身份验证方法以及针对 HelpDesk 的测试查询是否有效。

  • HTTP 401/403:令牌已过期或用户缺少“Web API”权限。

  • 工单的 HTTP 404:工单不存在或对该用户不可见;尚未授权的工单需要调度员角色。

  • 连接错误:检查包含端口的基础 URL(HelpDesk 的默认端口是 9000)。对于自签名的测试系统,--no-verify-tls 会有所帮助。

  • 更多详细信息请使用 --log-level DEBUG(日志输出到 stderr)。


安全说明

  • 凭据位于环境变量或 Authorization 标头中,永远不会被记录。

  • 服务器只执行登录用户被允许的操作——权限检查由 HelpDesk 负责。

  • apply_ticket_action 和 create_ticket 会修改数据,并且根据配置可能会触发发送给最终用户的电子邮件。对于测试,建议使用操作参数 "ticketextension.automail": "NEVER" 或使用测试系统。

  • get_ticket 默认返回工单的所有字段,包括个人数据——使用 fields 进行针对性限制。


英文摘要

暴露 i-net HelpDesk 工单 Web API 的 MCP 服务器:搜索、读取、创建和处理工单,支持附件。通过 stdio(凭据来自 INET_BASE_URL + INET_TOKEN)或通过 可流式 HTTP 运行,每个客户端通过发送自己的 Authorization: Bearer <token> 标头进行身份验证——并且,当未配置基础 URL 时,通过 X-Inet-Base-Url 标头选择 HelpDesk 实例。工具:server_info、search_tickets、get_ticket、list_ticket_actions、list_ticket_steps、get_ticket_step、create_ticket、apply_ticket_action。使用 --read-only 启动以仅暴露读取工具。

许可证

MIT。非 i-net software GmbH 的官方产品。 Web API 文档: https://docs.inetsoftware.de/helpdesk/help/webapi.ticket/p/ticket-web-api

Available Tools

8 tools
apply_ticket_actionApply ticket actionA

Apply a ticket action to an existing ticket - answering, closing, escalating and so on - and return the id of the new editing step. Call list_ticket_actions first: only the ids listed there are valid, and they differ per ticket, user and state. This changes the ticket, so confirm the action with the user when the intent is ambiguous.

ParametersJSON Schema
NameRequiredDescriptionDefault
textNo
action_idYes
ticket_idYes
attachmentsNo
step_fieldsNo
html_contentNo
ticket_fieldsNo
action_argumentsNo

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations provided, the description carries the full burden. It explicitly states that this tool changes the ticket, which is a behavioral disclosure. It also mentions that actions vary per ticket/user/state, implying context-dependence. However, it does not detail side effects like whether steps are immutable or if there are irreversible actions, but given the existence of an output schema, this is acceptable.

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 three sentences, each with a purpose. It front-loads the main purpose, then adds a crucial prerequisite warning, and concludes with a safety note. No wasted words. The structure is ideal for an MCP description.

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 complexity (8 parameters, no schema descriptions, no annotations), the description provides essential usage guidance. The presence of an output schema helps with return value understanding. The main gap is the lack of parameter explanations, but the tool's purpose and behavior are sufficiently outlined for an agent to understand when and how to use it, particularly with the hint to list actions first.

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 0%, so the description must compensate. It mentions 'text', 'attachments', 'step_fields', etc. only indirectly by saying 'answering, closing, escalating', but does not explain specific parameters like 'action_arguments' or 'ticket_fields'. The description adds context for action_id and ticket_id (validity and prerequisite), but for other parameters it relies on the schema which has no descriptions. Since 8 parameters that are mostly undocumented, the description could do more to explain how to use them.

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's purpose: 'Apply a ticket action to an existing ticket - answering, closing, escalating and so on - and return the id of the new editing step.' It uses specific verbs (apply, return) and names the resource (ticket). It also distinguishes from siblings by focusing on actions, while siblings like list_ticket_actions and get_ticket handle listing and retrieval.

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

Usage Guidelines5/5

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

The description provides explicit guidance: 'Call list_ticket_actions first: only the ids listed there are valid, and they differ per ticket, user and state.' This tells the agent the prerequisite step and warns about validity constraints. It also says to confirm with the user when intent is ambiguous, which is excellent for ambiguous situations.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

create_ticketCreate ticketA

Create a new ticket and return its id. text is the request text of the ticket. ticket_fields and action_arguments are optional and only needed for advanced cases - unknown ticket fields are rejected, unknown action arguments are ignored by the server.

ParametersJSON Schema
NameRequiredDescriptionDefault
textYes
owner_guidNo
attachmentsNo
html_contentNo
ticket_fieldsNo
action_argumentsNo

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A3.8/5.0
Behavior3/5

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

With no annotations provided, the description must carry the full burden. It states the return value (id) and warns about rejection of unknown ticket_fields versus silent ignoring of action_arguments, which is useful. However, it does not disclose whether the operation is destructive, if it requires authentication, or if there are rate limits, leaving gaps.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise at two sentences, immediately stating the core purpose. It front-loads the primary behavior and return value, then adds parameter notes. One minor improvement could be to structure the parameter notes more clearly, but overall it is efficient.

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 the tool has 6 parameters, 0% schema coverage, and no annotations, the description covers only a subset of parameters (text, ticket_fields, action_arguments) and lacks details on attachments, owner_guid, and html_content. The presence of an output schema helps but does not fully compensate for missing parameter explanations.

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?

Schema description coverage is 0%, so the description must compensate. It explains the critical `text` parameter and adds meaning to `ticket_fields` and `action_arguments` by noting their optionality and server behavior. However, `owner_guid`, `attachments`, and `html_content` are not described, leaving some parameters without context.

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 creates a new ticket and returns its ID. It distinguishes itself from sibling tools like search_tickets, get_ticket, and apply_ticket_action by focusing on creation, not retrieval or modification.

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

Usage Guidelines3/5

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

The description mentions that `ticket_fields` and `action_arguments` are optional and only for advanced cases, and notes that unknown fields are rejected while unknown arguments are ignored. However, it does not provide guidance on when to use this tool versus alternatives like apply_ticket_action, or when attachments or html_content should be used.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_ticketGet ticketA

Read one ticket with its fields and attributes. Pass fields to limit the response to the entries you need - the full record can be large and may contain personal data.

ParametersJSON Schema
NameRequiredDescriptionDefault
fieldsNo
ticket_idYes

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries full burden. It explicitly states the tool is read-only ('Read one ticket') and warns that the full record can be large and may contain personal data. This adds behavioral context beyond what structured data provides. It does not mention authentication, error handling, or idempotency, but the core safety trait is transparent.

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 two sentences with no wasted words. The first sentence front-loads the core purpose, and the second adds a practical usage tip. Every sentence earns its place.

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 (2 parameters, output schema present), the description covers the core action, a key parameter hint, and a data sensitivity warning. It does not discuss error behavior or edge cases, but the output schema fills return value details. The description is sufficient for an agent to use the tool correctly in most scenarios.

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?

Schema description coverage is 0%, so the description must compensate. It explains the `fields` parameter's purpose (limit response, avoid large/personal data) and why it is useful. The `ticket_id` parameter is not explained in text, but its purpose is obvious from name and context. The description adds meaningful value beyond the bare schema.

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 verb 'Read' and the resource 'one ticket with its fields and attributes'. It distinguishes itself from sibling tools like 'search_tickets' (multiple results) and 'create_ticket' (write) by specifying a single ticket retrieval. The purpose is specific and unambiguous.

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

Usage Guidelines3/5

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

The description provides a usage hint to pass the `fields` parameter to limit response size and avoid personal data, which is helpful. However, it does not explicitly state when to use this tool versus alternatives (e.g., 'search_tickets' for filtering, 'list_ticket_actions' for operations). The guidance is implied but lacks exclusions or comparisons.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_ticket_stepGet ticket stepA

Read one editing step of a ticket, including its text and the applied ticket action. Pass fields to reduce the returned fields and attributes.

ParametersJSON Schema
NameRequiredDescriptionDefault
fieldsNo
step_idYes
ticket_idYes

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A3.8/5.0
Behavior2/5

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

No annotations are provided, so the description must fully disclose behavior. It states it's a read operation ('Read'), but does not mention idempotency, rate limits, or whether the step is returned in a specific format. It hints at field filtering but lacks detail on what 'applied ticket action' means or if the action is mutable.

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 two sentences long with no wasted words. It front-loads the purpose ('Read one editing step...') and adds a helpful optimization hint ('Pass fields to reduce...'). Every sentence earns its place.

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?

The tool has a rich output schema (mentioned in context), so the description does not need to detail return values. It covers the key behavior (reading a step, including text and action) and parameter usage. No mention of error states or prerequisites, which is a minor gap for a complex tool with many siblings.

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?

Schema coverage is 0%, so the description must compensate. It explains the 'fields' parameter by saying 'Pass fields to reduce the returned fields and attributes', giving context not in the schema. However, it does not describe ticket_id and step_id beyond their names, which are clear from context.

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 'Read one editing step of a ticket', specifying the verb 'read' and the resource 'editing step' with the scope 'of a ticket'. This distinguishes it from siblings like list_ticket_steps (list) and get_ticket (different resource).

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

Usage Guidelines3/5

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

The description implies this is for reading a single step, but does not explicitly say when to use it over siblings (e.g., get_ticket for ticket-level info, list_ticket_steps for multiple steps). No alternatives or exclusions are mentioned, so it's adequate but lacking guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

list_ticket_actionsList ticket actionsA

List the ticket actions the authenticated user may currently apply to a ticket, as a map of action id to display name. The ids are the input for apply_ticket_action.

ParametersJSON Schema
NameRequiredDescriptionDefault
ticket_idYes

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A3.7/5.0
Behavior3/5

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

With no annotations provided, the description carries full burden. It mentions the action list is scoped to the authenticated user and returns a map, but omits details about permissions requirements, error conditions (e.g., invalid ticket_id), or whether the list could be empty.

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 sentences, no filler. The first sentence states the core purpose, the second links to a related sibling. Every word earns its place.

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?

For a simple list tool with one parameter and an output schema, the description covers the output format and workflow integration. It is nearly complete but lacks parameter documentation, which is a minor gap given the tool's simplicity.

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

Parameters1/5

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

The input schema has a required ticket_id with no description (0% schema coverage). The description does not elaborate on ticket_id format, source, or constraints, leaving the agent with no additional guidance beyond the schema.

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 lists ticket actions the authenticated user may apply, returning a map of id to display name. It distinguishes from sibling apply_ticket_action by noting the ids are its input.

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 implies usage as a precursor to apply_ticket_action, providing a natural workflow. However, it does not explicitly state when to use this tool over siblings like list_ticket_steps or get_ticket, nor does it mention exclusion criteria.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

list_ticket_stepsList ticket stepsA

List the editing steps (history) of a ticket. For a primary ticket in a bundle the steps of its secondary tickets are merged in. Use get_ticket_step for the text of a single step.

ParametersJSON Schema
NameRequiredDescriptionDefault
sinceNo
ticket_idYes

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A3.9/5.0
Behavior3/5

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

Annotations are absent, so the description carries the full burden. It discloses that for primary tickets in a bundle, steps from secondary tickets are merged, which is a key behavioral trait. However, it does not mention other important traits such as pagination, rate limits, data freshness, or what happens on error, which would be valuable for a history endpoint.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences long and front-loads the main purpose. It includes a behavioral detail (merged steps) and a sibling reference. Every sentence adds value, and there is no fluff. It could be slightly more structured (e.g., separate section for parameters) but is already efficient.

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 that the tool has an output schema (which explains return values) and only 2 simple parameters, the description does not need to cover return structure. It explains the bundle merging behavior and the sibling context. It might be slightly incomplete for agents needing to know about pagination or limits, but for a list endpoint with an output schema, it's largely sufficient.

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 0%, so the description must compensate. However, the description does not explain either parameter (since or ticket_id). The since parameter especially benefits from explanation (e.g., format or semantics). The ticket_id is somewhat self-explanatory but formal guidance is missing. Baseline for 0% coverage would be lower, but with only 2 params and one being clear from the property name, a 3 is appropriate.

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 lists 'editing steps (history) of a ticket' which is a specific verb+resource. It further distinguishes from siblings by mentioning behavior for bundle tickets and explicitly referencing the sibling `get_ticket_step` for single step retrieval, making it easy for an agent to differentiate.

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 context on when to use this tool (to list the entire step history) and when to use an alternative ('Use get_ticket_step for the text of a single step'). It doesn't explicitly say when not to use it or mention prerequisites, but the guidance on bundle tickets and the sibling reference is helpful.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

search_ticketsSearch ticketsA

Search tickets with the same phrase syntax as the Tickets application, for example printer or Resource:"First Level Support". Returns the matching ticket ids plus suggestions for fields and values that can narrow the query further.

ParametersJSON Schema
NameRequiredDescriptionDefault
limitNo
queryYes
startNo
localeNo

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A3.7/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It discloses that the tool returns matching ticket IDs plus suggestions and that it uses a specific syntax. However, it does not mention behavioral traits like pagination, rate limits, or whether the operation is read-only, though the search nature implies safety.

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 consists of two concise sentences. The first explains functionality and syntax, the second explains the return value. No unnecessary words are present.

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?

The description covers the main functionality and return value, and an output schema exists. However, it lacks explanation of the pagination parameters (limit, start) which are important for a search tool. Overall, it is reasonably complete but has a notable gap.

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?

With 0% schema description coverage, the description must compensate. It adds meaning for the query parameter by explaining the syntax and providing examples, but it does not describe the limit, start, or locale parameters at all. This is insufficient for a 4-parameter tool.

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 that the tool searches tickets using a specific phrase syntax, with examples like 'printer' or 'Resource:"First Level Support"'. It distinguishes the search action from sibling tools such as create_ticket or get_ticket by its purpose and return value.

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

Usage Guidelines3/5

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

The description provides usage guidance by referencing the Tickets application's syntax, but it does not explicitly state when to use this tool versus alternatives or when not to use it. The context is implied but not formalized.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

server_infoServer infoA

Report how this MCP server is configured and verify that the i-net HelpDesk can be reached with the current credentials. Use this first when a call fails with an authentication or connection error.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A4.7/5.0
Behavior4/5

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

No annotations are provided, so the description must convey behavioral traits. It clearly discloses the tool is read-only (reports/verifies) and connects it to server config and credential validation. It could be slightly improved by explicitly stating it has no side effects (like creating or modifying data), but the intent is clear enough from context.

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 two sentences, front-loaded with the core purpose, and contains no extraneous information. Every sentence earns its place.

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

Completeness5/5

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

Given that the tool has zero parameters, an output schema exists (so return values are documented elsewhere), and the sibling tools all focus on tickets, this description is complete. It explains what the tool does, when to use it, and implies what it does not do (mutations).

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 input schema has zero parameters and schema description coverage is 100% (trivially). The description adds meaning by explaining what the tool does with those zero parameters: it reports configuration and verifies connectivity. This is a case where the parameter semantics is inherently simple, and the description captures the purpose well.

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 uses a specific verb and resource: 'Report how this MCP server is configured and verify that the i-net HelpDesk can be reached with the current credentials.' It clearly distinguishes from sibling tools: all siblings deal with ticket operations, while this tool is about server and authentication status.

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

Usage Guidelines5/5

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

The description explicitly states when to use this tool: 'Use this first when a call fails with an authentication or connection error.' This gives clear guidance on the context and problem type that should trigger its invocation, and by omission implies it is not needed for normal ticket operations.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 8 tool updatesv0.1.0
    • First observedapply_ticket_action
    • First observedcreate_ticket
    • First observedget_ticket
    • First observedget_ticket_step
    • First observedlist_ticket_actions
    • First observedlist_ticket_steps
    • First observedsearch_tickets
    • First observedserver_info

TDQS

A4/5.0

Scored across 8 tools

Disambiguation5/5

Each tool targets a distinct operation in the ticket lifecycle: creation, retrieval, search, action listing, action application, step listing, and step reading. No two tools have overlapping purposes, making it easy for an agent to select the correct tool.

Naming Consistency4/5

Six of eight tools follow a clear verb_noun pattern (e.g., create_ticket, search_tickets, get_ticket). However, server_info is a noun_noun format that breaks the pattern, preventing a perfect score.

Tool Count5/5

With 8 tools, the server covers core ticket operations without being bloated. The number is well-scoped for a focused HelpDesk MCP server, fitting the recommended range comfortably.

Completeness3/5

The server provides create, read, search, and action application, but lacks a general update tool for modifying ticket fields (e.g., priority, assignee). There is also no delete tool. This is a notable gap, though the action application covers workflow state changes.

Maintenance

ActivitySlowing
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers