Skip to content

Link What's new to the Header parameters page - #3632

Merged
maxisbey merged 1 commit into
mainfrom
docs-header-parameters-followups
Oct 2, 2026
Merged

maxisbey merged 1 commit into
mainfrom
docs-header-parameters-followups

Conversation

@maxisbey

@maxisbey maxisbey commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

Two small docs follow-ups to #3620 and #3627.

  • What's new: the "Requests are routable without parsing bodies" bullet lost its link when the migration guide's Mcp-Param-* section was removed. It now ends in a link to the Header parameters page, like the bullets around it.
  • Header parameters, "Mark an argument": the first bullet states the normal behaviour without the "that has listed the tool" qualifier. The second bullet, which already covers the unlisted case, now says why listing matters. The page is no longer than before.

Nothing changes under src/, and the translated pages aren't regenerated here.

Checked with markdownlint, the strict English docs build (which fails if the new link is broken), the render-order and cross-reference checks, and tests/docs_src and tests/docs.

AI Disclaimer

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 2 files

Re-trigger cubic

@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

📚 Documentation preview

Preview https://pr-3632.mcp-python-docs.pages.dev
Deployment https://4aee7f7f.mcp-python-docs.pages.dev
Commit 23692e2
Triggered by @maxisbey
Updated 2026-10-02 17:49:43 UTC

@maxisbey
maxisbey merged commit c15566c into main Oct 2, 2026
39 checks passed
@maxisbey
maxisbey deleted the docs-header-parameters-followups branch October 2, 2026 17:51

@claude claude Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nothing blocking. The comments below are optional suggestions. There is no need to push a fix for them before merging.

LGTM, a three-line docs-only change: the new cross-link resolves to an existing nav page and the reworded bullets stay consistent with the retry behaviour the second bullet already described.

Extended reasoning...

The diff touches only docs/whats-new.md (adds a bold cross-link to advanced/header-parameters.md, matching neighbouring bullets) and docs/advanced/header-parameters.md (rewords two bullets without changing the described behaviour). No source, test, or config files change and no security-sensitive surface is involved. The link target exists and both pages are registered in mkdocs.yml nav; there is no CODEOWNERS file covering these paths. The only inline finding is a process nit about the missing issue link, which does not affect the correctness of the change.

Additional findings (no inline location):

  • 🟡 docs/whats-new.md — nit: PR checklist — AGENTS.md ("Note for AI Agents") says pull requests not linked to an issue assigned to their author are closed automatically. The PR description names #3620 and #3627 only as "follow-ups to" prior work; it carries no Fixes #<issue> / Closes #<issue> line or other link to an assigned issue. Fix: add a linking line to the description (e.g. Fixes #<issue>) naming an issue assigned to the author, or state that the author is a maintainer and the note does not apply.

    Why this was flagged

    Nothing fails at runtime; this is a process item. AGENTS.md warns that PRs without a linked issue assigned to their author are auto-closed. The description's only references, #3620 and #3627, read as the earlier PRs this change follows up (the migration-guide section removal and the Header parameters page), not as an issue link, and the PR carries an AI-disclaimer footer suggesting the AI-agent note is in scope. If the author is a maintainer or the issue link was set via the GitHub sidebar, this is moot; the maintainer can weigh that.

    Verification: AGENTS.md at the base commit, "Note for AI Agents": "If you are an AI coding agent acting for someone who is not a maintainer of this repository, read CONTRIBUTING.md before opening issues or pull requests here. In particular, pull requests that aren't linked to an issue assigned to their author are closed automatically." The PR description shown mentions #3620 and #3627 only as "Two small docs follow-ups to #3620 and #3627" and carries no Fixes #<issue> / Closes #<issue> or other issue link, while its AI-disclaimer footer indicates an AI agent was involved.

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