Skip to main content
Glama
snowild

Redmine MCP Server

by snowild

get_document_categories

Retrieve available document categories from Redmine to organize and classify project files effectively.

Instructions

取得所有可用的文件分類列表

Returns:
    格式化的文件分類列表

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • MCP tool handler function for 'get_document_categories'. Decorated with @mcp.tool() for automatic registration. Fetches categories via Redmine client and formats as a formatted table string.
    @mcp.tool()
    def get_document_categories() -> str:
        """
        取得所有可用的文件分類列表
        
        Returns:
            格式化的文件分類列表
        """
        try:
            client = get_client()
            categories = client.get_document_categories()
            
            if not categories:
                return "沒有找到文件分類"
            
            result = "可用的文件分類:\n\n"
            result += f"{'ID':<5} {'名稱':<25} {'預設':<8}\n"
            result += f"{'-'*5} {'-'*25} {'-'*8}\n"
            
            for category in categories:
                is_default = "是" if category.get('is_default', False) else "否"
                result += f"{category['id']:<5} {category['name']:<25} {is_default:<8}\n"
            
            return result
            
        except RedmineAPIError as e:
            return f"取得文件分類失敗: {str(e)}"
        except Exception as e:
            return f"系統錯誤: {str(e)}"
  • Helper method in RedmineClient class that queries the Redmine API for document categories enumeration.
    def get_document_categories(self) -> List[Dict[str, Any]]:
        """取得文件分類列表"""
        response = self._make_request('GET', '/enumerations/document_categories.json')
        return response.get('document_categories', [])
  • The @mcp.tool() decorator registers the get_document_categories function as an MCP tool.
    @mcp.tool()
Behavior2/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 of behavioral disclosure. It mentions the tool returns a '格式化的文件分類列表' (formatted document categories list), which hints at output structure, but lacks details on format type (e.g., JSON, list), pagination, error handling, or authentication needs. For a tool with zero annotation coverage, this leaves significant gaps in understanding its behavior.

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 and front-loaded, with the main purpose stated clearly in the first sentence. The second sentence adds value by specifying the return format. There's no wasted text, and both sentences contribute meaningfully to understanding the tool.

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's simplicity (0 parameters, no output schema, no annotations), the description is adequate but minimal. It covers the basic purpose and output format, which is sufficient for a read-only list operation. However, it lacks details on error cases or integration context, leaving room for improvement in completeness.

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, and schema description coverage is 100% (since there are no parameters to describe). The description doesn't need to add parameter semantics, as there are none to explain. A baseline score of 4 is appropriate for tools with no parameters, as there's no risk of missing parameter 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 tool's purpose: '取得所有可用的文件分類列表' (Get all available document categories list). It specifies the verb ('取得' - get) and resource ('文件分類列表' - document categories list), making the action and target clear. However, it doesn't distinguish this from sibling tools like 'get_issue_statuses' or 'get_priorities', which follow similar patterns for different resources.

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?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention any prerequisites, context for usage, or comparisons to sibling tools like 'get_projects' or 'get_trackers'. The agent must infer usage from the tool name alone, which is insufficient for optimal selection.

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/snowild/redmine-mcp'

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