Skip to content

Commit 5bad459

Browse files
authored
Merge pull request #42 from ycexiao/doc-other-agent
docs: add documentation for connecting the MCP server to chatgpt
2 parents 085ad6b + bd47b39 commit 5bad459

4 files changed

Lines changed: 63 additions & 6 deletions

File tree

‎docs/source/getting-started.rst‎

Lines changed: 40 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -191,12 +191,12 @@ How to use the local DiffPy MCP server
191191

192192
An MCP server is a bundle of tools, skills, and prompts. To use the the MCP
193193
server, users need to connect it to a LLM based-agent,
194-
such as ``Claude Code Desktop``, and the agent will decide when and how to
194+
such as ``Claude Desktop``, and the agent will decide when and how to
195195
interact with the MCP server in the conversation with users.
196196

197-
Connect to Claude Code Desktop
198-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
199-
1. Install ``Claude Code Desktop`` (hereafter referred to as ``Claude``).
197+
Connect to Claude Desktop
198+
~~~~~~~~~~~~~~~~~~~~~~~~~
199+
1. Install ``Claude Desktop`` (hereafter referred to as ``Claude``).
200200
2. Open ``Claude`` and open "Settings".
201201
3. Navigate to the "Developer" section.
202202
4. In the "Local MCP servers" region, click "Edit Config".
@@ -230,10 +230,44 @@ Connect to Claude Code Desktop
230230
6. Go to the "Local MCP servers" section and verify that the
231231
``diffpy.apps`` server is listed and active.
232232

233+
.. figure:: img/claude_screenshot.png
234+
:align: center
235+
236+
Figure 1: Screenshot of active ``diffpy.apps`` server in ``Claude``.
237+
238+
239+
Connect to ChatGPT Desktop
240+
~~~~~~~~~~~~~~~~~~~~~~~~~~
241+
1. Install ``ChatGPT Desktop`` (hereafter referred to as ``ChatGPT``).
242+
2. Open ``~/.codex/config.toml``.
243+
3. Add the following configuration:
244+
245+
.. code-block:: toml
246+
247+
[mcp_servers.diffpy_apps]
248+
command = "<path/to/python>"
249+
args = ["-m", "diffpy.apps.refinebase.refinement_server"]
250+
251+
Please see the section above on how to determine the correct
252+
``<path/to/python>`` for your environment.
253+
254+
4. Restart the ``ChatGPT``.
255+
256+
5. Open "Settings", and navigate to the "Integration" section. Open
257+
"Plugins" tab, and verify that the ``diffpy.apps`` server is listed in the
258+
"MCPs" field and active.
259+
260+
.. figure:: img/chatgpt_screenshot.png
261+
:align: center
262+
263+
Figure 2: Screenshot of active ``diffpy.apps`` server in ``ChatGPT``.
264+
265+
233266
How to use the MCP server
234267
~~~~~~~~~~~~~~~~~~~~~~~~~
235-
Once you have updated the configuration files successfully, ``Claude``
236-
will connect to the local DiffPy MCP server automatically whenever you open it.
268+
Once you have updated the configuration files successfully, agent like
269+
``Claude`` or ``ChatGPT`` will connect to the local DiffPy MCP server
270+
automatically whenever you open it.
237271

238272
Here is a simple example of conducting Ni structure refinement.
239273

58.2 KB
Loading
58 KB
Loading

‎news/doc-other-agent.rst‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
**Added:**
2+
3+
* No news added: Add documentation of connecting MCP server to ChatGPT desktop
4+
5+
**Changed:**
6+
7+
* <news item>
8+
9+
**Deprecated:**
10+
11+
* <news item>
12+
13+
**Removed:**
14+
15+
* <news item>
16+
17+
**Fixed:**
18+
19+
* <news item>
20+
21+
**Security:**
22+
23+
* <news item>

0 commit comments

Comments
 (0)