Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

MCP: one error model and one serializer for every tool (validation errors are returned as success)

未关闭
#92 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
重构
描述清晰度
基本清楚
活跃度
活跃
技术栈
csharp
领域
api, backend, cli

调研方向

Start with McpInvocationFilter, McpStdioToolCallTests.McpToolCall_WhenTheApiFails_IsReportedAsAToolError, and OutputHelper.WriteApiError to trace the existing error contract. Then inspect Features/Mcp/Tools, Program.cs, and McpHostCommand for duplicated handling and registration. Done means validation, write-service, serialization, logging, and registration behavior are unified without unreviewed golden or wire-contract changes.

由索引模型根据 Issue 内容生成。

描述

Priority: P1 Type: Refactor

Why

Sharing was started but the MCP side of the contract was never finished, so every other slice of #38 inherits the problem.

  • Validation and auth failures are returned as successful tool results (return """{"error": "..."}"""), about 20 sites across TimesheetMcpTools, LeaveMcpTools and AccountingMcpTools. API failures throw, so the SDK marks them isError. A client checking isError sees the first class as success.
  • A third class escapes as a protocol error: DateOnly.ParseExact in the tools throws FormatException for bad input, even though TimesheetCreateService.ParseDate already turns the same input into a validation exception.
  • TimesheetWriteResult.Success == false is an error on the CLI (UpdateCommand, AcceptCommand, CreateCommand) but serialised as ordinary content by the MCP tools.
  • McpInvocationFilter only records failure on a throw, so the local command log shows returned errors as successes.
  • Serialiser policy is split: OutputHelper.JsonOptions omits nulls, AccountingMcpTools copies that, the timesheet/leave/lookup tool classes write nulls, and CreateTimesheet alone uses OutputHelper.SerializeJson. This is why parity rows need PermittedDifferences like $.timesheet.invoiceId.
  • Adapter boilerplate is copied: three ResolveEmpId helpers with two different semantics, three "not logged in" strings, and the DI registration list duplicated between Program.cs and McpHostCommand (a new service must be registered twice).

Migrate

  • One base validation exception (or error record) that TimesheetValidationException, the leave validation exceptions and the import exceptions derive from; carry message, detail, recovery hint and mayHaveBeenApplied.
  • Map it once, in McpInvocationFilter, to a CallToolResult with IsError = true and the same {"error":{code,message,detail}} body the CLI --json envelope uses. Record the failure in the command log.
  • Remove every catch … return "{\"error\"…}" and every JsonOpts field from Features/Mcp/Tools; serialise through OutputHelper.SerializeJson.
  • Parse dates in tools through one invariant helper that throws the validation exception.
  • Treat Success == false from a write service the same way on both surfaces.
  • One AddTimeProServices() extension used by Program.cs and McpHostCommand; one shared tool helper for tenant/emp-id resolution.

How

Do this first; the other sharing issues assume it. McpStdioToolCallTests.ToolCall_WhenTheApiFails_IsReportedAsAToolError already proves the SDK maps a thrown exception to isError, so the filter can own the mapping and tools stop catching anything. OutputHelper.WriteApiError is the CLI half to mirror for detail and requestId.

Contract

Error payloads and null omission change MCP output. The code can land in a patch behind the existing goldens only if the old shapes are preserved; otherwise hold the wire change for 0.4.0 and regenerate goldens once (#71 first, so the regenerate is reviewable).

Part of #38.

主要语言
C#
星标
3
派生
0
平均合并
11 分钟
30 天内合并 PR
4

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 没有贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

SSWConsulting/TimePro.Tools 的其他 Issue

查看 SSWConsulting/TimePro.Tools 的全部 Issue

相似的 Issue

更多 C# Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。