docs: update the documentation for using Diffpy MCP - #47
sbillinge merged 4 commits into
Conversation
Sorry, something went wrong.
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #47 +/- ##
=======================================
Coverage 98.24% 98.24%
=======================================
Files 8 8
Lines 626 626
=======================================
Hits 615 615
Misses 11 11
|
Sorry, something went wrong.
| After connecting these tools to an agent, users can invoke DiffPy | ||
| functionalities and automate PDF refinements through conversation. | ||
|
|
||
| To better understand the convenience Diffpy Agent Interface brought, |
There was a problem hiding this comment.
Not sure it is helpful.
I felt a bit difficult to explain the benefits of using Diffpy MCP without bring a more detailed example.
Sorry, something went wrong.
|
@sbillinge, it's ready for review. |
Sorry, something went wrong.
sbillinge
left a comment
There was a problem hiding this comment.
Looks good. Small tweak
Sorry, something went wrong.
| functionalities and automate PDF refinements through conversation. | ||
|
|
||
| To better understand the convenience Diffpy Agent Interface brought, | ||
| let's consider the following scenario: |
There was a problem hiding this comment.
We don't need this. It will be evident to people that agents can help. We just want to get them started quickly. The only thing we need to say of a general nature is something like "Diffy.apps contains applications that help to make diffot.cmi easier to use. These include a software structure for using ai agents to run CMI and a macro language that can be useful for humans and agents" something like that, but change it so it is correct. You could mention MCp servers but have in mind the target audience. Who do you envisage reading this and what do you need to tell them in a way they can understand
Sorry, something went wrong.
|
@sbillinge, the documentation is ready for review. |
Sorry, something went wrong.
What problem does this PR address?
Update the documentation for Diffpy MCP
What should the reviewer(s) do?