CtrlK
BlogDocsLog inGet started
Tessl Logo

finkel/mcp-tool-naming

Guidelines for naming MCP tools, describing parameters, and documenting tools in a language- and framework-agnostic manner

97

1.02x
Quality

Pending

Does it follow best practices?

Impact

97%

1.02x

Average score across 5 eval scenarios

SecuritybySnyk

Pending

The risk profile of this skill

Overview
Eval results
Files

task.mdevals/scenario-4/

GitHub API Tools Documentation

Problem/Feature Description

DevTools Co. is building an MCP server for GitHub operations. They have three tools that need comprehensive documentation:

  1. Repository management - Create, list, and delete repositories
  2. Issue tracking - Create, update, and search issues
  3. Code review - Create pull requests, review code, merge changes

The tools are complete and working, but the documentation needs improvement. The current documentation is inconsistent across tools - some have detailed error sections, others don't; some mention implementation details like "makes HTTP POST request to GitHub API", others are too vague.

The documentation should be useful for AI agents across different platforms (some running on Windows, others on Linux/macOS). Agents need to understand what each tool does, what errors might occur, and how the tools relate to each other.

Output Specification

Create a JSON file github_tools_documentation.json containing complete documentation for three GitHub-related MCP tools. For each tool, include:

  1. Tool metadata: name, description
  2. Parameters: list with names, types, descriptions
  3. Returns: what the tool returns
  4. Errors: possible error conditions with consistent formatting
  5. Examples: example tool calls
  6. Related tools: references to other related tools
  7. Platform notes: any platform-specific considerations

Create documentation for these three tools:

  • github_repository_manage - Manage repositories (create, list, delete)
  • github_issue_track - Handle issues (create, update, search)
  • github_code_review - Code review operations (PRs, reviews, merges)

Ensure the documentation:

  • Avoids implementation details (no HTTP methods, library names, etc.)
  • Focuses on behavior and functionality
  • Uses consistent structure across all three tools
  • Includes platform considerations where relevant
  • Shows how tools relate to each other
  • Documents errors consistently
  • Starts each tool description with a concise one-liner (action + object)
  • Clearly documents output format (JSON shape, stable keys, nullable fields)

tile.json