Skip to main content
Glama

get_qiita_markdown_rules

Retrieve Qiita markdown syntax rules and cheat sheet for creating, updating, and formatting articles using the Qiita MCP Server.

Instructions

get Qiita markdown syntax rules, cheat sheet

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The handler function that implements the core logic of the 'get_qiita_markdown_rules' tool. It calls the Qiita API service to fetch markdown rules and returns a formatted success or error response.
    const getQiitaMarkdownRules = async (): Promise<any> => {
      try {
        const markdownRules = await apiService.getMarkdownRules();
        return createSuccessResponse(markdownRules);
      } catch (error) {
        const errorMessage = error instanceof Error ? error.message : String(error);
        return createErrorResponse(`Error fetching Qiita markdown rules: ${errorMessage}`);
      }
    };
  • The registration of the tool within the getToolDefinitions array, defining its name, description, empty parameters schema, and linking to the handler function.
    {
      name: "get_qiita_markdown_rules",
      description: "get Qiita markdown syntax rules, cheat sheet",
      parameters: {} as z.ZodRawShape,
      handler: () => getQiitaMarkdownRules()
    }
  • Helper function to format successful responses, used by the tool handler.
    const createSuccessResponse = (content: string): any => {
      return {
        content: [
          { 
            type: "text", 
            text: content 
          }
        ]
      };
    };
  • Helper function to format error responses, used by the tool handler.
    const createErrorResponse = (errorMessage: string): any => {
      return {
        content: [
          { 
            type: "text", 
            text: `Error: ${errorMessage}` 
          }
        ],
        isError: true
      };
    };
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 states the tool retrieves markdown rules, implying a read-only operation, but doesn't specify aspects like whether it requires authentication, rate limits, or the format of the returned data. This leaves significant gaps in understanding how the tool behaves in practice.

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 extremely concise and front-loaded: 'get Qiita markdown syntax rules, cheat sheet'. It uses minimal words to convey the core purpose without redundancy or unnecessary elaboration, making it efficient and easy to parse.

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?

Given the lack of annotations and output schema, the description is incomplete for a tool that likely returns structured data (e.g., markdown rules). It doesn't hint at the response format, potential errors, or any behavioral traits, leaving users with insufficient context to use the tool effectively beyond its basic purpose.

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 the input schema has 100% description coverage (though empty). The description doesn't need to add parameter semantics, as there are none to explain. A baseline score of 4 is appropriate since the schema fully covers the lack of parameters, and the description doesn't introduce confusion.

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 Qiita markdown syntax rules, cheat sheet'. It uses a specific verb ('get') and identifies the resource ('Qiita markdown syntax rules'), making the action and target clear. However, it doesn't explicitly differentiate from sibling tools like 'get_qiita_item', which might also retrieve content-related information.

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 sibling tools or contexts where this tool is appropriate, such as when needing formatting rules versus actual articles. Without such guidance, users must infer usage from the tool name alone.

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

Related 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/2bo/qiita-mcp-server'

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