Skip to main content
Glama
wuqunfei

github-mcp-server-js

by wuqunfei

render_markdown

Convert Markdown to HTML using GitHub's renderer. Supports standard Markdown and GitHub Flavored Markdown for resolving issue references and mentions.

Instructions

Render a Markdown string to HTML using GitHub's Markdown renderer. Returns the rendered HTML as a plain text string (not JSON-encoded). Use mode "markdown" (default) for standard Markdown. Use mode "gfm" (GitHub Flavored Markdown) to enable cross-references such as #42 linking to issues and @mentions — requires the context parameter to specify the repository (e.g. "owner/repo") for resolving those references. This endpoint is stateless: it renders and returns HTML without modifying any data. Docs: https://docs.github.com/en/rest/markdown/markdown#render-a-markdown-document

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
modeNoRendering mode. "markdown" (default) renders standard Markdown. "gfm" renders GitHub Flavored Markdown with cross-reference support (requires the context parameter to resolve issue and PR references).
textYesThe Markdown text to render to HTML.
contextNoRepository context for resolving cross-references in gfm mode, in "owner/repo" format (e.g. "octo-org/octo-repo"). Ignored when mode is "markdown".
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 and does well: it discloses that the return value is a plain text string (not JSON-encoded), that the operation is stateless and modifies no data, and that gfm cross-references depend on the context parameter. This is meaningful behavioral detail beyond the raw schema.

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 concise and efficiently structured: three sentences that immediately state the purpose, then explain mode behavior and statelessness, with a link to docs. Every sentence adds value and there is no redundant filler.

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?

For a simple, stateless rendering tool, the description covers all essential aspects: input (markdown text), output (plain HTML string), modes, the context parameter requirement, and side-effect-free behavior. No output schema exists, but the return format is explicitly described, making this complete.

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 100%, so the baseline is 3. The description adds some value by explaining the practical difference between 'markdown' and 'gfm' modes and the purpose of 'context', but it largely reiterates what the schema already states clearly.

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+resource construction: 'Render a Markdown string to HTML using GitHub's Markdown renderer.' It clearly distinguishes the tool from all siblings, none of which perform markdown rendering, and states the exact output format.

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?

Provides clear guidance on when to use each mode: default 'markdown' for standard markdown and 'gfm' for cross-references, including the requirement for the 'context' parameter in gfm mode. It also notes the endpoint is stateless, which helps set expectations, though it does not explicitly discuss alternatives or exclusions.

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/wuqunfei/github-mcp-server-js'

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