Add LLM/agent documentation and remove MCP server#1268
Merged
raphaeltimbo merged 2 commits intopetrobras:mainfrom Feb 24, 2026
Merged
Add LLM/agent documentation and remove MCP server#1268raphaeltimbo merged 2 commits intopetrobras:mainfrom
raphaeltimbo merged 2 commits intopetrobras:mainfrom
Conversation
Restructure CLAUDE.md with a usage section containing a quick-reference table for all 15 run_* methods, units conventions, example rotors, and pointers to on-demand cookbook recipes. Split cookbook into 12 focused recipe files in docs/cookbook/ so agents read only what they need. Add MCP server instructions for domain context. Expand AGENTS.md with a quick-start card.
The MCP server in ross/mcp/ is removed along with its dependencies, entry point, tutorial, and all documentation references.
raphaeltimbo
changed the title
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1268 +/- ##
==========================================
+ Coverage 77.55% 78.03% +0.48%
==========================================
Files 48 46 -2
Lines 13366 13283 -83
==========================================
Hits 10366 10366
+ Misses 3000 2917 -83 Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
LLM/Agent-oriented documentation
CLAUDE.mdwith a usage section containing a quick-reference table for all 15run_*methods, units conventions, example rotors, and pointers to on-demand cookbook recipesdocs/cookbook/so agents read only what they need (modal analysis, Campbell diagram, critical speed, static analysis, unbalance response, frequency response, time response, UCS & Level 1, faults, bearings advanced, building rotors, gotchas)docs/cookbook/README.mdas an index for all recipesAGENTS.mdwith a quick-start card for agent onboardingRemove MCP server
ross/mcp/package (server,__main__,__init__)tutorial_part_6.ipynb)mcpoptional dependency andross-mcpentry point frompyproject.toml--ignore=ross/mcpfrompytest.iniCLAUDE.md, user guide toctree, and release notesTest plan
pytest rosspasses (567 passed, 6 skipped).py,.toml,.ini,.md,.rst, or.jsonfiles