Skip to content

knowledge(web-services): describe API objects intended for MCP tools - #233

Draft
Javier Armesto Gonzalez (javiarmesto) wants to merge 2 commits into
microsoft:mainfrom
javiarmesto:claude/api-page-abouttext-for-mcp
Draft

Javier Armesto Gonzalez (javiarmesto) wants to merge 2 commits into
microsoft:mainfrom
javiarmesto:claude/api-page-abouttext-for-mcp

Conversation

@javiarmesto

Copy link
Copy Markdown

API objects intended for the Business Central MCP server can expose a bare entity caption where an agent needs to understand document filters or computed values. Add web-services knowledge for the documented description precedence: AboutText, EntitySetCaption, then camel-cased EntityName. The good/bad samples cover both API pages and queries, with descriptions and actual document-type filters kept consistent.

The article preserves valid alternatives: missing AboutText is not a defect when the fallback is adequate or MCP use is not established, and AboutTitle is not required solely for MCP. Sources include the Learn API page/query documentation and a pinned Microsoft API query with AboutText and no AboutTitle. Its scope is BC 28+ online environments with the relevant MCP support; it does not claim that extraction first appeared in 28.0 or cover the earlier preview.

The contribution is motivated by a 22-run API generation evaluation whose syntax rubric flagged AboutText omissions in 13 runs, including one incomplete solution. These are omission flags, not measured tool-selection failures. The missing metadata is not diagnosed by the tested standard analyzers. The owning domain is web-services because the concern is the API-to-tool metadata contract, distinct from UI teaching tips.

Validation:

  • Frontmatter, registered review fixtures, review contract, and knowledge-index/retrieval checks passed. Two existing keyword-count warnings concern unrelated articles.
  • Good and bad companion files compile independently against BC 28.2 symbols with AL compiler 18.0.43.1464, CodeCop, UICop, and PerTenantExtensionCop; only expected sample-filename warnings remain.
  • Focused page/query probes accept AboutText without AboutTitle. Live MCP extraction and historical deployments were not exercised.

The review-skill edit only selects this knowledge; the facts and exceptions remain in the article. No stable protocol changes or customer-specific code are included.

…t for MCP tools

The Business Central MCP server takes the tool description from
AboutText, then EntitySetCaption, then EntityName. API pages without
AboutText reach agents as a bare entity name. LLMs treat AboutText as
a UI teaching-tip property and omit it on API objects; no analyzer
flags it. Observed in 13 of 22 generated solutions of a read-only
SalesMargin query API.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant