update-integrations-prs
Skill445 starsChanged 11 days agoMITView on GitHub
Process open LangChain docs integration PRs against the hosted-guide featuring policy (50K monthly downloads or maintainer feature override). Rebase an integration PR, convert to external YAML, feature an integration, or check package downloads for docs eligibility.
- Commits and pushes
In this repository25 other files it gives its agents.
- AGENTS.mdAGENTS.md
- .github/copilot-instructions.mdCopilot instructions
- .cursor/rules/docs-style.mdcCursor rule
- add-docs-pageSkill
- docs-code-samplesSkill
- docs-editSkill
- docs-restructureSkill
- docs-reviewSkill
- docs-team-voiceSkill
- docs-tooling-notionSkill
- submit-integrationSkill
- verify-against-sourceSkill
- deepagents-codeSkill
- deepagentsjsSkill
- deepagentsSkill
- openwikiSkill
- release-researchSkill
- ship-docs-updateSkill
- langgraph-docsSkill
- write-timestampSkill
- pandas-patternsSkill
- deep-agentsSkill
- langchainSkill
- langgraphSkill
- langsmithSkill
The file
Show its rules and text
We split this skill into the rules it gives an agent
14 rules. About 0 are common, 6 are distinctive, and 8 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈6
Distinctive · estimate
This author's own choices. Worth a look.
8
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- could be automatic: a setting could enforce it
- Distinctive: line 74
Keep contributor commits; put the conversion in a new commit after rebase.
- Very specific: line 91
Prefer partner docs, then public GitHub/GitLab README, then PyPI/npm.
- Very specific: line 95
Nav / redirects: remove docs.json entries and redirects for deleted never-on-main pages.
- Distinctive: line 96
Deep Agents / indexes: if the PR added provider cards that main no longer uses, prefer downloads tables and index grids.
- Distinctive: line 102
Keep (or fix) hosted MDX; test code examples when touching them.
- Very specific: line 104
Prefer langchain imports over langchain_core when editing kept pages.
- Very specific: line 106
Update src/docs.json if adding a page that should stay.
- Very specific: line 114
If maintainerCanModify: false, say so and ask whether to open a replacement PR.
- Distinctive: line 118
Ask for clarification rather than assuming package identity or feature overrides.
- Very specific: line 119
Never fabricate download counts, docs URLs, or package names.
- Distinctive: line 121
Never hand-edit generated overview tables.
- Very specific: line 122
When appending to packages.yml, ensure a trailing newline first.
- Very specific: line 123
Run make lint_prose FILES="..." on changed MDX before handoff when prose changed.
- Distinctive: line 124
Follow repo git safety: no bare git push.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Update integrations PRs
Process contributor integration docs PRs in langchain-ai/docs so they match the hosted-guide eligibility rules from #4865.
For new listings filed as GitHub issues (issue form + integration-submission label), use the submit-integration skill instead. That path creates listing changes for CI to open a PR.
Policy
| Case | Action |
| ≥50K monthly downloads (PyPI or npm) or maintainer feature override | Keep hosted MDX. Ensure correct integration: frontmatter. May set highlight: true in packages.yml and regenerate overview via partner_pkg_table (never hand-edit overview.mdx). |
| Under 50K, not featured | Remove hosted pages. Add YAML to scripts/data/integration_external_docs.yaml. Surface via downloads tables / all_providers. Prefer partner docs URLs. Keep packages.yml when there is a public LangChain-related package. |
Policy source: src/oss/contributing/publish-langchain.mdx and src/oss/contributing/integrations-langchain.mdx.
Workflow checklist
Copy and track:
- [ ] Identify PR + package name(s)
- [ ] Report monthly downloads (PyPI and/or npm)
- [ ] Decide: hosted/feature vs external
- [ ] Rebase onto upstream/main (keep contributor commits)
- [ ] Apply conversion in a **separate** commit
- [ ] Verify net diff vs main
- [ ] Report result; do **not** push unless asked1. Inspect the current branch
git branch --show-current
gh pr view --json number,title,url,author,maintainerCanModify,files,body
git diff --stat upstream/main...HEADFind the LangChain-related package name(s) from packages.yml, MDX install snippets, or registry metadata. Ignore unrelated packages with similar names.
2. Measure downloads
PyPI (last ~30 days, no mirrors):
curl -s "https://pypistats.org/api/packages/<pkg>/overall?mirrors=false" \
| python3 -c "import sys,json; d=json.load(sys.stdin); data=d.get('data',[]); last30=data[-30:] if len(data)>=30 else data; print(sum(x.get('downloads',0) for x in last30))"
curl -s "https://pypistats.org/api/packages/<pkg>/recent"npm (last month):
curl -s "https://api.npmjs.org/downloads/point/last-month/<pkg>"Report the number to the user before converting when they asked for downloads only.
3. Rebase
git fetch upstream main
git rebase upstream/main- Keep contributor commits; put the conversion in a new commit after rebase.
- On heavy merge history, cherry-pick content commits onto
upstream/main, then convert. - Drop obsolete Card grids that main replaced with
IntegrationDownloads. - Drop redirects for pages that were never on
main. - Drop unrelated
packages.ymldownload-count churn from bot commits.
4a. External conversion (under 50K)
- Delete hosted MDX (component page and provider page if present).
Add YAML under the correct language + component in
scripts/data/integration_external_docs.yaml:- name: ClassOrDisplayName pypi: langchain-example # or npm: "@org/pkg" under javascript: docs_url: https://partner.example/docsPrefer partner docs, then public GitHub/GitLab README, then PyPI/npm.
- Downloads snippet (sort by
data-sort-value): add a row to the matchingsrc/snippets/oss/*-*-downloads.mdx(for examplepython-sandboxes-downloads.mdx). Match existing badge markup. all_providers: card with externalhref(alphabetical). Useicon="link"or an existing provider icon. Card body max 160 characters. If a draft description is longer, shorten it to one factual sentence ≤160 characters; do not invent claims. Limit:PROVIDER_CARD_DESCRIPTION_MAX_LENinscripts/provider_card_limits.py.packages.yml: append only for a public LangChain-related package. Ensure a trailing newline before appending. Omitpath: .. Skip if the source repo is private or not a normal public VCS listing.- Nav / redirects: remove
docs.jsonentries and redirects for deleted never-on-main pages. Do not add redirects for pages that never shipped. - Deep Agents / indexes: if the PR added provider cards that main no longer uses, prefer downloads tables and index grids; keep brief mentions only when main already lists providers that way.
Align listings with partner docs, not stale PR page counts.
4b. Hosted / featured path (≥50K or override)
- Keep (or fix) hosted MDX; test code examples when touching them.
- Frontmatter: follow templates under
src/oss/*/integrations/**/TEMPLATE.mdx. Do not setfeatured: trueunless a maintainer asked. - Prefer
langchainimports overlangchain_corewhen editing kept pages. - For featuring: set
highlight: trueinpackages.ymlonly when asked; regenerate overview with the partner package table tool, do not hand-editoverview.mdx. - Update
src/docs.jsonif adding a page that should stay.
5. Commit and handoff
- Conversion commit message focuses on why (threshold / external listing / feature).
- Show
git diff --stat upstream/main...HEADand downloads in the summary. - Note
maintainerCanModifyfor push later. - Do not push unless the user asks. Use force-with-lease after rebase when pushing to the PR head.
- If
maintainerCanModify: false, say so and ask whether to open a replacement PR.
Hard rules
- Ask for clarification rather than assuming package identity or feature overrides.
- Never fabricate download counts, docs URLs, or package names.
- Never edit
build/. - Never hand-edit generated overview tables.
- When appending to
packages.yml, ensure a trailing newline first. - Run
make lint_prose FILES="..."on changed MDX before handoff when prose changed. - Follow repo git safety: no bare
git push; no force to main; no commit unless asked (except when the user said "go" / "next branch" for this workflow, commit the conversion).
Common pitfalls
| Pitfall | Fix |
| Wrong package (similar name on PyPI) | Confirm against install snippets and partner repo |
| Re-adding Card grids removed on main | Use IntegrationDownloads / YAML only |
| Redirects for never-shipped pages | Delete them |
| Duplicate table rows | Remove YAML if keeping hosted page |
| Private source repo | Skip incomplete packages.yml entry |
| JS + Python packages | Add both YAML sections / download rows when both exist |
Reference
- Eligibility docs:
/oss/contributing/publish-langchain#eligibility-for-hosted-guides - YAML data:
scripts/data/integration_external_docs.yaml - Downloads snippets:
src/snippets/oss/*-downloads.mdx - Package registry:
packages.yml - Policy PR: https://github.com/langchain-ai/docs/pull/4865
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

