Skip to content

Commit 5b4fddc

Browse files
docs: update agent documentation and remove outdated images (#53)
1 parent 4721059 commit 5b4fddc

5 files changed

Lines changed: 4 additions & 99 deletions

File tree

docs/introduction/use-with-agents.md

Lines changed: 3 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ toc:
77

88
# Use with agents
99

10-
Information about this logging library can be shared with different agents using the [workleap-logging](https://skills.sh/workleap/wl-logging/workleap-logging) agent skill or the [Context7](https://context7.com/) MCP server.
10+
Information about this logging library can be shared with different agents using the [workleap-logging](https://skills.sh/workleap/wl-logging/workleap-logging) agent skill.
1111

1212
## Install agent skill
1313

@@ -18,109 +18,13 @@ npx skills add https://github.com/workleap/wl-logging --skill workleap-logging
1818
```
1919

2020
!!!tip
21-
The `skills.sh` CLI will prompt you to choose whether to install the skill globally or within a project. We recommend installing it **locally** so it is available for code review tools such as [Claude Code code review](https://github.com/anthropics/claude-code-action).
21+
The `skills.sh` CLI will prompt you to choose whether to install the skill globally or within a project. We recommend installing it **locally** so it is available for code review tools such as [Copilot](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review) or [Claude Code](https://github.com/anthropics/claude-code-action).
2222
!!!
2323

24-
### Try it :rocket:
24+
## Try it :rocket:
2525

2626
Once the skill is installed, start an agent and ask it to setup a project:
2727

2828
```
2929
I'm setting up logging in a new React + TypeScript application. Setup the project to use Workleap logging using the documented APIs and patterns, and write a simple log to the console with a logger.
3030
```
31-
32-
## Setup Context7 MCP server
33-
34-
Context7 is an MCP server that provides AI assistants with real-time, version-specific programming documentation and code examples. Instead of relying only on a model's training data, it allows AI tools to fetch up-to-date information directly from authoritative sources (such as the code repository or the official documentation) at request time. This helps reduce hallucinations and errors caused by outdated APIs, especially in coding environments such as IDEs or editor integrations.
35-
36-
### VS Code
37-
38-
For a quick setup, install the Context7 MCP server directly from the VS Code Marketplace:
39-
40-
[<img alt="Install in VS Code (npx)" src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Context7%20MCP&color=0098FF" />](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%7B%22name%22%3A%22context7%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40upstash%2Fcontext7-mcp%40latest%22%5D%7D)&nbsp;&nbsp;&nbsp;[<img alt="Install in VS Code Insiders (npx)" src="https://img.shields.io/badge/VS_Code_Insiders-VS_Code_Insiders?style=flat-square&label=Install%20Context7%20MCP&color=24bfa5" />](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%7B%22name%22%3A%22context7%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40upstash%2Fcontext7-mcp%40latest%22%5D%7D)
41-
42-
#### Configuration file
43-
44-
Alternatively, you can configure the MCP server manually by updating the VS Code [MCP configuration file](https://code.visualstudio.com/docs/copilot/customization/mcp-servers):
45-
46-
+++ Remote server connection
47-
```json
48-
"mcp": {
49-
"servers": {
50-
"context7": {
51-
"type": "http",
52-
"url": "https://mcp.context7.com/mcp",
53-
"headers": {
54-
"CONTEXT7_API_KEY": "YOUR_OPTIONAL_API_KEY"
55-
}
56-
}
57-
}
58-
}
59-
```
60-
+++ Local server connection
61-
```json
62-
"mcp": {
63-
"servers": {
64-
"context7": {
65-
"type": "stdio",
66-
"command": "npx",
67-
"args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_OPTIONAL_API_KEY"]
68-
}
69-
}
70-
}
71-
```
72-
+++
73-
74-
!!!tip
75-
For more details about supported clients and configurations, refer to the Context7 [clients documentation](https://context7.com/docs/resources/all-clients).
76-
!!!
77-
78-
#### Verify the connection
79-
80-
Open the Extensions view in VS Code and locate the `context7` MCP server. Click the gear icon to access its settings and confirm that the server is running:
81-
82-
:::align-image-left
83-
![VS Code server status](../static/agents/vscode-context7-mcp-server.png){width=449}
84-
:::
85-
86-
### Claude Code
87-
88-
To install Context7 with Claude Code, open a terminal and execute one of the following commands:
89-
90-
+++ Remote server connection
91-
```bash
92-
claude mcp add --header "CONTEXT7_API_KEY: YOUR_OPTIONAL_API_KEY" --transport http context7 https://mcp.context7.com/mcp
93-
```
94-
+++ Local server connection
95-
```bash
96-
claude mcp add context7 -- pnpmx -y @upstash/context7-mcp --api-key YOUR_OPTIONAL_API_KEY
97-
```
98-
+++
99-
100-
!!!tip
101-
For more details and alternative installation options, refer to the Context7 [Claude Code documentation](https://context7.com/docs/clients/claude-code).
102-
!!!
103-
104-
#### Verify the connection
105-
106-
Open Claude Code and execute the `/mcp` command:
107-
108-
:::align-image-left
109-
![Claude Code MCP list](../static/agents/claude-code-mcp-list.avif){width=422}
110-
:::
111-
112-
Then, select the `Context7 MCP server` to view its details, including connection status, authentication, and available tools:
113-
114-
:::align-image-left
115-
![Claude Code server details](../static/agents/claude-code-mcp-details.avif){width=636}
116-
:::
117-
118-
Alternatively, you can verify the connection from a terminal by executing the `claude mcp list` command. The `context7` MCP server should be listed as **connected**.
119-
120-
### Try it :rocket:
121-
122-
Once the MCP server is set up, ask the agent to use Context7 to perform tasks such as generating boilerplate code:
123-
124-
```
125-
I'm setting up logging in a new React + TypeScript application. Use context7 "/workleap/wl-logging" library to set up Workleap logging using the documented APIs and patterns, and write a simple log to the console with a logger.
126-
```
-16.5 KB
Binary file not shown.
-8.67 KB
Binary file not shown.
-197 KB
Binary file not shown.

prompts/CREATE_SKILL.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ The generated skill should:
3030
* Provide clear, concise explanations and examples.
3131
* Be reliable for pull request reviews, developer support, and onboarding.
3232
* Minimize token usage by focusing only on relevant `wl-logging` concepts and APIs.
33+
* Not have a description exceeding a maximum length of 1024 characters.
3334

3435
Relevant questions the skill should be able to answer:
3536

0 commit comments

Comments
 (0)