langchain-ai/docs
1
0
Fork 0
mirror of https://github.com/langchain-ai/docs.git synced 2026-07-22 04:15:25 -04:00
Code Issues 490 Packages Projects Releases Wiki Activity

[GH-ISSUE #2235] Verbose OpenAPI descriptions appearing in SEO metadata and llms.txt #277

New Issue
Closed
opened 2026-02-17 17:19:32 -05:00 by yindo · 0 comments
yindo commented 2026-02-17 17:19:32 -05:00
Owner
Copy Link
Copy Source

Originally created by @mdrxy on GitHub (Jan 14, 2026).
Original GitHub issue: https://github.com/langchain-ai/docs/issues/2235

Long, technical OpenAPI operation description fields are being used verbatim for:

  1. SEO page descriptions (meta description tags)
  2. The llms.txt file at https://docs.langchain.com/llms.txt

This results in verbose, multi-line technical documentation appearing where concise summaries are expected.

Examples

A2A JSON-RPC endpoint (https://docs.langchain.com/langsmith/agent-server-api/a2a/a2a-json-rpc)

Current description in OpenAPI:

Communicate with an assistant using the Agent-to-Agent (A2A) Protocol over JSON-RPC 2.0.
This endpoint accepts a JSON-RPC envelope and dispatches based on `method`.

**Supported Methods:**
- `message/send`: Send a message and wait for the final Task result.
- `message/stream`: Send a message and receive Server-Sent Events (SSE) JSON-RPC responses.
...

Other affected endpoints identified in llms.txt:

  • MCP Post
  • OAuth Setup Callback
  • OAuth Callback Get
  • Terminate Session

This is bleeding into the pages' <meta> tags with full verbose descriptions, markdown formatting, bullet pointed lists, etc.

Solution

Mintlify supports the x-mint extension to override page metadata separately from the OpenAPI description field. Add x-mint.metadata.description to operations that need SEO-friendly summaries:

"/a2a/{assistant_id}": {
  "post": {
    "operationId": "post_a2a",
    "summary": "A2A JSON-RPC",
    "description": "Communicate with an assistant using the Agent-to-Agent (A2A) Protocol...[verbose technical docs]",
    "x-mint": {
      "metadata": {
        "description": "Send messages to assistants using the A2A Protocol over JSON-RPC 2.0."
      }
    }
  }
}

References

Originally created by @mdrxy on GitHub (Jan 14, 2026). Original GitHub issue: https://github.com/langchain-ai/docs/issues/2235 Long, technical OpenAPI operation description fields are being used verbatim for: 1. SEO page descriptions (meta description tags) 2. The `llms.txt` file at `https://docs.langchain.com/llms.txt` This results in verbose, multi-line technical documentation appearing where concise summaries are expected. ## Examples A2A JSON-RPC endpoint (https://docs.langchain.com/langsmith/agent-server-api/a2a/a2a-json-rpc) Current description in OpenAPI: ``` Communicate with an assistant using the Agent-to-Agent (A2A) Protocol over JSON-RPC 2.0. This endpoint accepts a JSON-RPC envelope and dispatches based on `method`. **Supported Methods:** - `message/send`: Send a message and wait for the final Task result. - `message/stream`: Send a message and receive Server-Sent Events (SSE) JSON-RPC responses. ... ``` Other affected endpoints identified in `llms.txt`: - MCP Post - OAuth Setup Callback - OAuth Callback Get - Terminate Session This is bleeding into the pages' `<meta>` tags with full verbose descriptions, markdown formatting, bullet pointed lists, etc. ## Solution Mintlify supports the `x-mint` extension to override page metadata separately from the OpenAPI description field. Add `x-mint.metadata.description` to operations that need SEO-friendly summaries: ``` "/a2a/{assistant_id}": { "post": { "operationId": "post_a2a", "summary": "A2A JSON-RPC", "description": "Communicate with an assistant using the Agent-to-Agent (A2A) Protocol...[verbose technical docs]", "x-mint": { "metadata": { "description": "Send messages to assistants using the A2A Protocol over JSON-RPC 2.0." } } } } ``` --- References - Mintlify docs: https://www.mintlify.com/docs/api-playground/openapi-setup
yindo added the internal label 2026-02-17 17:19:32 -05:00
yindo changed title from Verbose OpenAPI descriptions appearing in SEO metadata and `llms.txt` to [GH-ISSUE #2235] Verbose OpenAPI descriptions appearing in SEO metadata and `llms.txt` 2026-06-05 17:26:02 -04:00
yindo closed this issue 2026-06-05 17:26:03 -04:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
deepagents
docs-infra
external
external
help wanted
integration
internal
internal
javascript
js/ts
langchain
langgraph
langsmith
needs-title
pull-request
Mirrored from GitHub Pull Request
 python
reference
No Label internal
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/docs#277
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?